autodoc_pydantic uses poetry for environment and package management.
git clone https://github.com/mansenfranzen/autodoc_pydantic.git
cd autodoc_pydantic
poetry install -E dev
To quickly execute the test suite within your current developer environment with pytest, run poetry run pytest
.
For more sophisticated testing, you can use tox for different test environments. A test environment is characterized by varying versions of autodoc_pydantic's dependencies like pydantic, sphinx and sphinx-tabs:
- Test a specific environment:
poetry run tox -e py38-pydantic17-sphinx34
- Test the latest stable versions from pypi:
poetry run tox -e latest
- Test the current developer versions from git repositories:
poetry run tox -e development
- Test all available environments:
poetry run tox
(not recommended)
Please visit the tox.ini
for all available test environments.
Note
Using tox has the benefit of completing the entire build-deploy-test-cycle:
- build source distribution from
pyproject.toml
- create specified virtual environment for test execution
- install source distribution in virtual environment
- run tests within virtual environment via pytest
- provide test coverage report
autodoc_pydantic's documentation is generated with sphinx. To generate the HTML documentation, please use the following:
poetry shell
cd docs
make clean && make html
The generated documentation can be found under docs/build/html/index.html
.