https://github.com/sourcegraph/doctree

Skip to content
 
Sign up

  * Product
      + Features
      + Mobile
      + Actions
      + Codespaces
      + Packages
      + Security
      + Code review
      + Issues
      + Integrations
      + GitHub Sponsors
      + Customer stories
  * Team
  * Enterprise
  * Explore
      + Explore GitHub
      + Learn and contribute
      + Topics
      + Collections
      + Trending
      + Learning Lab
      + Open source guides
      + Connect with others
      + The ReadME Project
      + Events
      + Community forum
      + GitHub Education
      + GitHub Stars program
  * Marketplace
  * Pricing
      + Plans
      + Compare plans
      + Contact Sales
      + Education

[                    ] 

  *  
    #
    In this repository All GitHub |
    Jump to |

  * No suggested jump to results

  *  
    #
    In this repository All GitHub |
    Jump to |
  *  
    #
    In this organization All GitHub |
    Jump to |
  *  
    #
    In this repository All GitHub |
    Jump to |

Sign in
Sign up
{{ message }}

sourcegraph / doctree Public

  * Notifications
  * Fork 3
  * Star 218

First-class library docs tool: supports every language, symbol
search, finds usage examples automagically. Based on tree-sitter,
runnable standalone or via http://doctree.org

License

Apache-2.0 License
218 stars 3 forks
Star
Notifications

  * Code
  * Issues 1
  * Pull requests 0
  * Actions
  * Security
  * Insights

More

  * Code
  * Issues
  * Pull requests
  * Actions
  * Security
  * Insights

This commit does not belong to any branch on this repository, and may
belong to a fork outside of the repository.
main
Switch branches/tags
[                    ]
Branches Tags
Could not load branches
Nothing to show
{{ refName }} default View all branches
Could not load tags
Nothing to show
{{ refName }} default
View all tags
1 branch 0 tags
Code

Latest commit

@slimsag
slimsag README: swap with doctree.org
...
f5823b1 Apr 30, 2022
README: swap with doctree.org
f5823b1

Git stats

  * 63 commits

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
cmd/doctree
dev server: workaround bug in elm-spa with "/github.com" routes
appea...
Apr 27, 2022
docs
Elm code now served; hot code swapping enabled
Apr 20, 2022
doctree
indexer: do not return error if index data dir does not exist
Apr 29, 2022
frontend
better category detection
Apr 29, 2022
.gitattributes
add gitattributes file (helps Windows contributors)
Apr 19, 2022
.gitignore
make "task" just work
Apr 19, 2022
.tool-versions
initialize repository
Apr 19, 2022
Dockerfile
Dockerfile: it works now!
Apr 29, 2022
LICENSE
initialize repository
Apr 19, 2022
README.md
README: swap with doctree.org
Apr 30, 2022
TODO
better category detection
Apr 29, 2022
Taskfile.yml
Taskfile: correct 'task build' dependency chain
Apr 29, 2022
go.mod
gzip responses
Apr 25, 2022
go.sum
gzip responses
Apr 25, 2022
renovate.json
chore(deps): add renovate.json
Apr 20, 2022
View code
Experiment! Super early stages! When can I try it? doctree:
First-class library docs tool for every language Try it out
(EXTREMELY early stages) Screenshots Development

README.md

 Experiment! Super early stages!

Imagine an API docsite generator that generates something like http:/
/pkg.go.dev but:

  * Works with any language
  * Has symbol-level search
  * Automatically surfaces usage examples
  * Supports both private code and open source

That's what we're building here!

 When can I try it?

If you'd like to try it out once we have an early version, let us
know on Twitter or open an issue - we'd love people to try it out as
we develop it!

Actual project README begins here :)

---------------------------------------------------------------------

 doctree: First-class library docs tool for every language

Features (aspirational):

  * Symbol search
  * Finds usage examples automagically
  * Based on tree-sitter
  * Runnable standalone or via http://doctree.org (not yet online)

 Try it out (EXTREMELY early stages)

Probably not worth trying out unless you're incredibly excited about
this idea.

Use Docker for now (working on single-binary builds still):

Run the server:

docker run -it --publish 3333:3333 --rm --name doctree --volume ~/.doctree:/home/nonroot/.doctree sourcegraph/doctree:dev

In a folder with Go code you'd like to see docs for, index it (for a
large project like golang/go expect it to take ~52s for now. It's not
multi-threaded.):

docker run -it --volume $(pwd):/index --volume ~/.doctree:/home/nonroot/.doctree --entrypoint=sh sourcegraph/doctree:dev -c "cd /index && doctree index ."

Navigate to https://localhost:3333

 Screenshots

image

image

image

 Development

We'd love any contributions!

To get started see docs/development.md

About

First-class library docs tool: supports every language, symbol
search, finds usage examples automagically. Based on tree-sitter,
runnable standalone or via http://doctree.org

Resources

Readme

License

Apache-2.0 License

Stars

218 stars

Watchers

8 watching

Forks

3 forks

Releases

No releases published

Packages 0

No packages published

Contributors 3

  * @slimsag slimsag Stephen Gutekanst
  * @jhchabran jhchabran Jean-Hadrien Chabran
  * @renovate-bot renovate-bot WhiteSource Renovate

Languages

  * Go 49.9%
  * Elm 43.9%
  * Dockerfile 3.5%
  * HTML 2.7%

  *  (c) 2022 GitHub, Inc.

  * Terms
  * Privacy
  * Security
  * Status
  * Docs
  * Contact GitHub
  * Pricing
  * API
  * Training
  * Blog
  * About

You can't perform that action at this time.
You signed in with another tab or window. Reload to refresh your
session. You signed out in another tab or window. Reload to refresh
your session.