Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Conversation

@jalvesz
Copy link
Contributor

@jalvesz jalvesz commented Aug 7, 2024

Proposal to start putting in place a Sphinx based documentation for stdlib. Relates to #697

It already covers the documentation in the specs. Needed a change in the way of including external files for the examples

TODO:

  • How to enable embedding or linking the FORD generated dev doc to the Sphinx-generated user doc?
  • Polish deployment
  • Change welcome page? currently using the README content

Building locally to test:

cd doc
python -m pip install -r requirements.txt
make html

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

Successfully merging this pull request may close these issues.

1 participant

Morty Proxy This is a proxified and sanitized view of the page, visit original site.