Skip to content

docs: generate and publish API documentation - #72

Open
prateek-dagar wants to merge 6 commits into
rspeer:masterfrom
prateek-dagar:docs-setup
Open

docs: generate and publish API documentation#72
prateek-dagar wants to merge 6 commits into
rspeer:masterfrom
prateek-dagar:docs-setup

Conversation

@prateek-dagar

Copy link
Copy Markdown

This PR configures Sphinx documentation for the langcodes repository to resolve issue #41 and adds the configuration for Read the Docs.

Key Changes:

  • Switch theme to modern 'sphinx-book-theme'.
  • Configure MyST-Parser to render the README.md directly on the main index page.
  • Exclude internal submodules (such as build_data, data_dicts, language_lists, registry_parser, tag_parser, util) to present a clean, public-facing API reference.
  • Add sphinx-copybutton for code block convenience.
  • Add 'docs' test environment to tox.ini for local validation.
  • Configure .readthedocs.yaml using the latest stable ubuntu-24.04 image with Python 3.12 for automated Read the Docs builds.
  • Integrate the documentation build test check into the GitHub Actions CI workflow.

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.

2 participants