Initial sphinx docs setup #814
Conversation
docs/conf.py
Outdated
| copyright = '2021, shannonzhu' | ||
| author = 'shannonzhu' |
There was a problem hiding this comment.
Not sure what the correct copyright and author is. Filled in placeholders but will fix based on suggestions.
There was a problem hiding this comment.
I'd suggest saying something like "The typing team"
| .. toctree:: | ||
| :maxdepth: 2 | ||
| :caption: Contents: | ||
|
|
There was a problem hiding this comment.
Open to thoughts / follow-up PRs for a good initial skeleton TOC to shape the first iteration of docs!
There was a problem hiding this comment.
How much do we want to steal from mypy docs? https://mypy.readthedocs.io/en/latest/#overview-type-system-reference
| # The theme to use for HTML and HTML Help pages. See the documentation for | ||
| # a list of builtin themes. | ||
| # | ||
| html_theme = 'alabaster' |
There was a problem hiding this comment.
I think we should consider using the python docs theme https://github.com/python/python-docs-theme to convey that this is the official docs for typing and friends.
Another one to consider: recently I've seen some people in the docs WG using the furo theme https://github.com/pradyunsg/furo for new docs too since its more responsive on mobile browsers. Maybe we can get some input from them later on.
There was a problem hiding this comment.
Good idea - following up (a bit late) with #818 to set up python docs theming and hopefully an easier build for this. Also open to using the furo theme instead, if you'd be willing to help investigate and change it!
|
How about merging this with suggested changes and then iterating as necessary? I think this is a fine start. |
|
Good point, I'll merge this PR now and we can write more docs in new PRs. |
Run Sphinx initialize to set up structure for Python typing documentation.
See typing-sig discussion: https://mail.python.org/archives/list/[email protected]/thread/4E7V7MVO4FQVYPVELMCAYFEIYJRXDSY2/
Python docs community issue: python/docs-community#8