docs: set up Sphinx + ReadTheDocs pipeline for auto-generated API reference - #1832
Open
jacalata wants to merge 7 commits into
Open
docs: set up Sphinx + ReadTheDocs pipeline for auto-generated API reference#1832jacalata wants to merge 7 commits into
jacalata wants to merge 7 commits into
Conversation
Add Read the Docs configuration file for documentation build
Added configuration settings for Sphinx documentation. Direct copy from example conf file.
Updated project information to load from pyproject.toml.
- Add docs optional-dependencies group (sphinx, tomli) to pyproject.toml - Wire up .readthedocs.yaml to install .[docs] extra - Fix conf.py: correct pyproject.toml path, use importlib.metadata for version, switch to alabaster theme, use tomllib/tomli compat import - Add minimal docs/index.rst - Fix RST docstring errors in connection_item, site_item, job_item, task_item that caused Sphinx build warnings/errors Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
On push to master, builds Sphinx HTML and opens a PR from docs-update into gh-pages so the generated API reference can be reviewed before going live. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2 tasks
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
Introduces Sphinx + ReadTheDocs alongside the existing Jekyll site on gh-pages.
Long-term goal is to replace
api-ref.mdon gh-pages. Keepingapi-ref.mdin sync with the code is currently manual and dev-driven; Sphinx auto-generates the same content from docstrings, giving devs a smoother update path (write docstrings, docs regenerate). Concepts and tutorials stay in Jekyll.Not surfacing this in the Jekyll site yet -- docstring coverage across the models package is too thin for the generated reference to be an improvement over the current
api-ref.md. Merging the pipeline now unblocks incremental docstring work without a public-facing rush.What's included
.readthedocs.yaml-- RTD build configdocs/conf.py-- Sphinx config, reads project details frompyproject.tomldocs/index.rst-- table of contents +.. automodule:: tableauserverclient :members:.github/workflows/docs.yml-- triggers onpush: branches: [master], builds Sphinx, opens an automated PR intogh-pagesatsphinx/pyproject.toml-- addsdocs = [sphinx, tomli, furo]optional-deps groupconnection_item.py,job_item.py,site_item.py,task_item.py(side effect of the initial Sphinx pass)Notes for reviewers
master, notdevelopment. Docs regen only on the release-to-public branch; PRs and dev-branch churn don't rebuild.furo). Willing to swap the theme if that becomes a merge blocker.gh-pages/sphinx/, but the Jekyll site has no links to that path yet. Once docstring coverage is good enough to surface, we add nav links to the Jekyll templates.Test plan
.readthedocs.yaml(validated locally by runningsphinx-build -b html docs sphinx_build).github/workflows/docs.ymllinter-clean; runtime not exercised until this is onmaster