Skip to content

Add sphinx config#50

Merged
javidahmed64592 merged 4 commits into
mainfrom
add-sphinx-config
Apr 13, 2026
Merged

Add sphinx config#50
javidahmed64592 merged 4 commits into
mainfrom
add-sphinx-config

Conversation

@javidahmed64592
Copy link
Copy Markdown
Owner

This pull request introduces a new SphinxConfig Pydantic model to centralize and simplify Sphinx documentation configuration. The model encapsulates project metadata and Sphinx settings, and is now used throughout the documentation build process. Related refactoring updates the conf.py config file to use this model, and new tests ensure the model and its integration work as expected. The pull request also updates some dependencies.

Sphinx documentation configuration refactor:

  • Added a new SphinxConfig Pydantic model in template_python/models.py to encapsulate Sphinx configuration and project metadata, with properties for project name, package name, copyright, and RST prolog substitutions.
  • Added a get_sphinx_config() function in template_python/workflows.py to construct and return a SphinxConfig instance using values from pyproject.toml.
  • Refactored docs/source/conf.py to use the new SphinxConfig model for all project and Sphinx settings, replacing previous direct function calls and constants. [1] [2]

Testing improvements:

  • Added unit tests for the SphinxConfig model in tests/test_models.py and for the get_sphinx_config() integration in tests/test_workflows.py. [1] [2] [3]

Dependency updates:

  • Added pydantic>=2.13.0 to main dependencies and bumped versions for mypy and sphinx-autodoc-typehints in pyproject.toml. [1] [2]

@javidahmed64592 javidahmed64592 merged commit c84bbd2 into main Apr 13, 2026
11 checks passed
@javidahmed64592 javidahmed64592 deleted the add-sphinx-config branch April 13, 2026 21:19
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