-
Notifications
You must be signed in to change notification settings - Fork 1k
docs(dev): add meta docs on writing docs #18163
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: William Woodruff <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am generally in favor of this, thanks for getting it started!
One nit inline.
How does this page relate to other documentation stuff like https://github.com/pypi/warehouse/blob/51ffd8ff87d763509486ac3cd03e07cdb92be693/docs/dev/development/getting-started.rst#building-documentation ? (that section is stale too, since we don't do Python 3.8 any more, and everything is kinda sorta self-contained)
======================= | ||
|
||
The developer documentation is hosted at `warehouse.pypa.io`_. It's written in | ||
`reStructuredText`_ and built using `Sphinx`_. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We allow Markdown as well, by including myst_parser
. See https://github.com/pypi/warehouse/blob/51ffd8ff87d763509486ac3cd03e07cdb92be693/docs/dev/architecture.md for one example.
Huh, I completely missed that section! Unless you feel like it's worth keeping, perhaps we could remove that and break the doc documentation out fully? IMO there will be enough here for it to need its own hierarchy. |
Signed-off-by: William Woodruff <[email protected]>
Signed-off-by: William Woodruff <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to go!
This adds some development-level docs on writing docs.
Note: this is an initial set; I'll follow up with more detailed sections on writing new sections, adding files, etc.
CC @Thespi-Brain @ewdurbin