Skip to content

Add trio documentation to devdocs #1031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
math2001 opened this issue Apr 27, 2019 · 4 comments
Closed

Add trio documentation to devdocs #1031

math2001 opened this issue Apr 27, 2019 · 4 comments

Comments

@math2001
Copy link
Member

Over the past few days, I've been adding (locally) the trio documentation to devdocs, an "API Documentation Browser", and testing it out. It makes it much faster to search for functions and methods documentation, here's a quick gif:

trio-devdocs

Note: the icon is just local. Once merged into devdocs, it'll be the proper one.

I figured I'd just make sure it's OK with everyone.

Here are the pages I've included:

  • Trio’s core functionality
  • I/O in trio
  • Introspecting and extending Trio with trio.hazmat
  • Testing made easier with trio.testing

All the other ones don't document any API, so I think people should refer to the real docs.

I'm not sure what the footer should be though. For each pages, devdocs displays a little footer with the copyright infos. For Python for example:

image

I used this for trio:

© 2017-2019 Nathaniel J. Smith
Licensed under MIT and Apache2.

If that's good, then I think everything should be cool, and I can submit my PR :-)

@njsmith could you close this issue when you think everything's fine?

@njsmith
Copy link
Member

njsmith commented Apr 28, 2019

Sounds good to me!

What's the mechanism for keeping the docs up to date as they evolve? Is it ingesting the sphinx docs directly, or...?

@math2001
Copy link
Member Author

What's the mechanism for keeping the docs up to date as they evolve? Is it ingesting the sphinx docs directly, or...?

Yep, it scraps the html and stores the different parts its interested in (so, when a user asks for the docs on devdocs, it doesn't re-ask the sphinx docs). To update a documentation, they have to bump the version manually, and it'll then re-scrap and update the cache.

@njsmith
Copy link
Member

njsmith commented Apr 28, 2019

Hmm, too bad we can't automate it. But I guess if people are using it and it gets out of date, then they'll notice and we can deal with it then...

Anyway, sounds good and I don't think there's anything else to do, so hitting close as requested :-)

@njsmith njsmith closed this as completed Apr 28, 2019
@pquentin
Copy link
Member

pquentin commented Apr 28, 2019

The last time we talked about copyright year we ended up deciding that we should keep 2017 forever: #510. Should we do the same in devdocs?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants