Skip to content
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

Sphinx documentation for stdlib specs #859

Draft
wants to merge 18 commits into
base: master
Choose a base branch
from

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