Repository navigation
Conversation
rmad17
marked this pull request as ready for review
October 6, 2026 05:54
…/mintlify-poc-server-python
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a docs build to the SDK repo. Run one command and it turns our docstrings, README and guides into a folder of ready-to-publish pages, plus a navigation file that describes the sidebar. We commit that folder as
docs/dist/, so a docs site can pick it up and publish it as it is.The repo owns both the content and the structure. The sidebar follows the real package layout, and every page is generated from what is already in the code and the Markdown files, so adding a module or a guide needs no extra setup.
There are no changes to the SDK source code or public API.
How it works
sphinx-autoapireadssrc/and writes a reference page for every public module, using the docstrings we already have.docs/mintlify_export/, finishes the job when the build ends:README.md,CONTRIBUTING.mdandexamples/*.mdinto MDX pagesnavigation.jsondocs/dist/, which we commit so the output can be published as is.The extension uses only the standard library and imports nothing from the SDK or from
conf.py. Every project-specific value is amintlify_*setting indocs/conf.py, so the folder can be moved to another repo unchanged. Its ownREADME.mdexplains the settings.Nothing needs editing when docs grow. A new module appears in the reference and the sidebar on the next build. A new file in
examples/appears as a new guide.What gets published
The sidebar follows the real package layout. A package or subpackage is a folder, a module is a page, and folders sort before pages. The Guides section starts collapsed and API Reference starts open.
Each reference page opens with an Import block, for example
from auth0_server_python.auth_server.anonymous.client import AnonymousClient, followed by the module's classes and functions with a[source]link to the definition on GitHub. The colors for signatures and code blocks are embedded in the pages, so the artifact needs no stylesheet.In the guides, GitHub alerts become callouts. A link to another guide opens that guide's page and is followed by a GitHub link.
Changes
docs/conf.pymintlify_*settings and the sidebar skeletondocs/mintlify_export/guides.py(Markdown to MDX),reference.py(reference pages),navigation.py(sidebar tree),style.py(colors and icons)docs/_templates/autoapi/docs/index.rst,docs/Makefilemake jsonwrites the artifact andmake htmlgives a local previewpyproject.toml,docs/requirements.txt,poetry.lockdocsdependency group withsphinxandsphinx-autoapi.gitignoredocs/dist/docs/dist/Pydantic
Configinner classes are skipped, since they are implementation noise.Running it
poetry install --with docs cd docs make json O=-EO=-Emakes Sphinx re-read every file, so the output is the same every time. Ifdocs/dist/was committed up to date,git statusshows no changes afterwards.Testing
No SDK source changed, so there are no new unit tests. The existing suite still passes:
poetry run pytestreports 745 passed.What is checked on the generated output:
@mdx-js/mdx.navigation.jsonhas a matching page.Things to know
make jsonprints about 34 Sphinx warnings from RST formatting in existing docstrings, such as indented lists and Markdown fences. They predate this PR and are not touched here.main, which suits docs for the latest version. Versioned docs would need them pinned to a tag.main.Checklist