Skip to content

feat: converting documentation to mkdocs #5276

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.

Sign up for GitHub

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

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

feat: converting documentation to mkdocs #5276

wants to merge 1 commit into from

Conversation

gvwilson
Copy link
Contributor

@gvwilson gvwilson commented Jul 10, 2025 •
edited
Loading

  • Re-introduce links between .md files in root directory (taken out because they don't resolve when those files are transcluded from pages/*.md).
  • Include content from docstrings in hand-written Python code.
  • Include content from docstrings in generated Python code.
  • Include navigation links in left nav bar.
  • Clean up warnings produced by mkdocs (most resulting from poor formatting of source material).
  • Add some kind of linting for docstring style (currently supposed to be google according to mkdocs.yml).
  • Move scripts/gen_ref_pages.py into commands.py.

@gvwilson gvwilson requested a review from LiamConnors July 10, 2025 13:57
@gvwilson gvwilson added feature something new P1 needed for current cycle documentation written for humans labels Jul 10, 2025
@gvwilson gvwilson force-pushed the mkdocs-conversion branch from d6b6592 to 5eec0b0 Compare July 11, 2025 16:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@LiamConnors LiamConnors Awaiting requested review from LiamConnors

At least 1 approving review is required to merge this pull request.

Assignees

@gvwilson gvwilson

@LiamConnors LiamConnors

Labels
documentation written for humans feature something new P1 needed for current cycle
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gvwilson @LiamConnors