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

Draft: docs: Generate documentation with sphinx #121

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Conversation

Melkor333
Copy link
Contributor

This PR will add documentation generation with sphinx.
It's using (a manually patched version of) md-click (I sent upstream a mail hoping they might merge one of the fixes...) and autodocs to generate docs for the most relevant code.

TODOs:

  • Make the index.rst a bit more pretty. Optimally it would show the content of the README.md. Maybe we should convert it to rst and then just merge it into the index.rst 🤔
  • We really need to write some docs on the config.toml

@Melkor333 Melkor333 self-assigned this Nov 11, 2024
@Melkor333 Melkor333 marked this pull request as draft November 11, 2024 07:58
@Melkor333
Copy link
Contributor Author

This should also close #113 when finished.

@Melkor333
Copy link
Contributor Author

Got internal feedback that maybe gitbook or vuebook might be a "more modern" approach than going back to sphinx... Since everything is markdown the only missing piece would be the pydocs which could probably be converted to md with something like pydoc-markdown

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