From 268043ca01863bdd63df0733db1cb0ead745404e Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Mon, 7 Aug 2023 10:18:21 +0000 Subject: [PATCH 1/8] Add mypy and test coverage report for docs. --- .gitlab-ci.yml | 3 ++- .gitlab-ci.yml.jinja | 3 ++- .readthedocs.yaml | 5 +++++ Makefile | 17 +++++++++++++---- Makefile.jinja | 17 +++++++++++++---- copier.yaml | 1 - requirements/lint.txt | 2 +- src/serious_scaffold/cli.py | 4 ---- src/{{ module_name }}/cli.py.jinja | 4 ---- 9 files changed, 36 insertions(+), 20 deletions(-) diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index dc5e03a4..4c82cf8a 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -70,8 +70,9 @@ pages: - /^v(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)$/ script: - env | sort - - make dev-docs + - make dev-docs,lint,tests - make docs + - make reports stage: build_release release: release: diff --git a/.gitlab-ci.yml.jinja b/.gitlab-ci.yml.jinja index 6540c106..d7ecbba3 100644 --- a/.gitlab-ci.yml.jinja +++ b/.gitlab-ci.yml.jinja @@ -87,8 +87,9 @@ pages: - /^v(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)$/ script: - env | sort - - make dev-docs + - make dev-docs,lint,tests - make docs + - make reports stage: build_release release: release: diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 43ba0242..177e2ff4 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -2,10 +2,15 @@ build: os: ubuntu-22.04 tools: python: '3' + jobs: + post_build: + - make reports python: install: - extra_requirements: - docs + - lint + - tests method: pip path: . version: 2 diff --git a/Makefile b/Makefile index 638c45a0..823e23ea 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,9 @@ -.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild +.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild mypy-reports tests-reports reports # Construct pipenv run command with or without site-packages flag when not in CI environment and pipenv command exists. SITE_PACKAGES_FLAG = $(shell [ "${SS_SITE_PACKAGES}" = "true" ] && echo --site-packages) PIPRUN := $(shell [ "${CI}" != "true" ] && command -v pipenv > /dev/null 2>&1 && echo pipenv ${SITE_PACKAGES_FLAG} run) +PUBLIC_DIR := $(or $(READTHEDOCS_OUTPUT),public) # Remove common intermediate files. clean: @@ -15,7 +16,7 @@ clean: Pipfile* \ coverage.xml \ dist \ - public + $(PUBLIC_DIR) find . -name '*.egg-info' -print0 | xargs -0 rm -rf find . -name '*.pyc' -print0 | xargs -0 rm -f find . -name '*.swp' -print0 | xargs -0 rm -f @@ -72,7 +73,15 @@ upload: ${PIPRUN} python -m twine upload dist/* docs: - ${PIPRUN} python -m sphinx.cmd.build docs public + ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR} docs-autobuild: - ${PIPRUN} python -m sphinx_autobuild docs public --watch src + ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR} --watch src + +mypy-reports: + ${PIPRUN} python -m mypy docs tests src --html-report ${PUBLIC_DIR}/$@ + +tests-reports: + ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/$@ . + +reports: mypy-reports tests-reports diff --git a/Makefile.jinja b/Makefile.jinja index 53ddeb8a..5ff9d69d 100644 --- a/Makefile.jinja +++ b/Makefile.jinja @@ -1,8 +1,9 @@ -.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild +.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild mypy-reports tests-reports reports # Construct pipenv run command with or without site-packages flag when not in CI environment and pipenv command exists. SITE_PACKAGES_FLAG = $(shell [ "${SS_SITE_PACKAGES}" = "true" ] && echo --site-packages) PIPRUN := $(shell [ "${CI}" != "true" ] && command -v pipenv > /dev/null 2>&1 && echo pipenv ${SITE_PACKAGES_FLAG} run) +PUBLIC_DIR := $(or $(READTHEDOCS_OUTPUT),public) # Remove common intermediate files. clean: @@ -17,7 +18,7 @@ clean: Pipfile* \ coverage.xml \ dist \ - public + $(PUBLIC_DIR) find . -name '*.egg-info' -print0 | xargs -0 rm -rf find . -name '*.pyc' -print0 | xargs -0 rm -f find . -name '*.swp' -print0 | xargs -0 rm -f @@ -74,7 +75,15 @@ upload: ${PIPRUN} python -m twine upload dist/* docs: - ${PIPRUN} python -m sphinx.cmd.build docs public + ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR} docs-autobuild: - ${PIPRUN} python -m sphinx_autobuild docs public --watch src + ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR} --watch src + +mypy-reports: + ${PIPRUN} python -m mypy docs tests src --html-report ${PUBLIC_DIR}/$@ + +tests-reports: + ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/$@ . + +reports: mypy-reports tests-reports diff --git a/copier.yaml b/copier.yaml index 9d360f42..792304a7 100644 --- a/copier.yaml +++ b/copier.yaml @@ -6,7 +6,6 @@ _exclude: - __pycache__ - copier.yaml - copier.yml - - docs/modules/serious_scaffold.settings.rst - includes - src/serious_scaffold - ~* diff --git a/requirements/lint.txt b/requirements/lint.txt index 8b8f70fe..725098a8 100644 --- a/requirements/lint.txt +++ b/requirements/lint.txt @@ -1,6 +1,6 @@ # Requirements for lint. black isort -mypy +mypy[reports] ruff toml-sort diff --git a/src/serious_scaffold/cli.py b/src/serious_scaffold/cli.py index bb0aa6d5..2cda5489 100644 --- a/src/serious_scaffold/cli.py +++ b/src/serious_scaffold/cli.py @@ -23,7 +23,3 @@ def main() -> None: # NOTE(huxuan): click object is used for document generation. # Reference: https://github.com/tiangolo/typer/issues/200#issuecomment-796485787 typer_click_object = typer.main.get_command(app) - - -if __name__ == "__main__": - app() # pragma: no cover diff --git a/src/{{ module_name }}/cli.py.jinja b/src/{{ module_name }}/cli.py.jinja index 2f7b3a19..9182c4de 100644 --- a/src/{{ module_name }}/cli.py.jinja +++ b/src/{{ module_name }}/cli.py.jinja @@ -23,7 +23,3 @@ def main() -> None: # NOTE(huxuan): click object is used for document generation. # Reference: https://github.com/tiangolo/typer/issues/200#issuecomment-796485787 typer_click_object = typer.main.get_command(app) - - -if __name__ == "__main__": - app() # pragma: no cover From 06c35e0075a4cdf1b7b4e596969987dea13896ed Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Mon, 7 Aug 2023 10:23:18 +0000 Subject: [PATCH 2/8] Add report in github actions. --- .github/workflows/release.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8aac09a0..9842f7a1 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -30,8 +30,9 @@ jobs: cache: pip python-version: 3.x - run: env | sort - - run: make dev-docs + - run: make dev-docs,lint,tests - run: make docs + - run: make reports - name: Upload pages artifact uses: actions/upload-pages-artifact@v2 with: From 4ade6735115f242cdacd41ba80b45245f0eb30f4 Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Mon, 7 Aug 2023 10:34:34 +0000 Subject: [PATCH 3/8] Disable docs mypy reports due to error on readthedocs. --- Makefile | 2 +- Makefile.jinja | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 823e23ea..45527a41 100644 --- a/Makefile +++ b/Makefile @@ -79,7 +79,7 @@ docs-autobuild: ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR} --watch src mypy-reports: - ${PIPRUN} python -m mypy docs tests src --html-report ${PUBLIC_DIR}/$@ + ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/$@ tests-reports: ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/$@ . diff --git a/Makefile.jinja b/Makefile.jinja index 5ff9d69d..4b530c6b 100644 --- a/Makefile.jinja +++ b/Makefile.jinja @@ -81,7 +81,7 @@ docs-autobuild: ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR} --watch src mypy-reports: - ${PIPRUN} python -m mypy docs tests src --html-report ${PUBLIC_DIR}/$@ + ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/$@ tests-reports: ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/$@ . From 9ab98afd79f86d9c1da4b4a1a594cbeb29e3b7a7 Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Tue, 8 Aug 2023 10:57:42 +0800 Subject: [PATCH 4/8] Unify the path to readthedocs. --- .github/workflows/release.yml | 2 +- .gitlab-ci.yml | 2 +- .gitlab-ci.yml.jinja | 2 +- Makefile | 8 ++++---- Makefile.jinja | 8 ++++---- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 9842f7a1..3766d71b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -36,7 +36,7 @@ jobs: - name: Upload pages artifact uses: actions/upload-pages-artifact@v2 with: - path: public + path: public/html - id: deployment name: Deploy to GitHub Pages uses: actions/deploy-pages@v2 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 4c82cf8a..c89b5ee0 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -59,7 +59,7 @@ package: pages: artifacts: paths: - - public + - public/html except: refs: - schedules diff --git a/.gitlab-ci.yml.jinja b/.gitlab-ci.yml.jinja index d7ecbba3..4b00b8ba 100644 --- a/.gitlab-ci.yml.jinja +++ b/.gitlab-ci.yml.jinja @@ -76,7 +76,7 @@ package: pages: artifacts: paths: - - public + - public/html except: refs: - schedules diff --git a/Makefile b/Makefile index 45527a41..a24c7e71 100644 --- a/Makefile +++ b/Makefile @@ -73,15 +73,15 @@ upload: ${PIPRUN} python -m twine upload dist/* docs: - ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR} + ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR}/html docs-autobuild: - ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR} --watch src + ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR}/html --watch src mypy-reports: - ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/$@ + ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/html/$@ tests-reports: - ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/$@ . + ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/html/$@ . reports: mypy-reports tests-reports diff --git a/Makefile.jinja b/Makefile.jinja index 4b530c6b..739417e2 100644 --- a/Makefile.jinja +++ b/Makefile.jinja @@ -75,15 +75,15 @@ upload: ${PIPRUN} python -m twine upload dist/* docs: - ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR} + ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR}/html docs-autobuild: - ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR} --watch src + ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR}/html --watch src mypy-reports: - ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/$@ + ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/html/$@ tests-reports: - ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/$@ . + ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/html/$@ . reports: mypy-reports tests-reports From 6e73f9f2fcc10287ccf9bc4883c4a3406846c268 Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Tue, 8 Aug 2023 11:10:06 +0800 Subject: [PATCH 5/8] Try to override the build process for readthedocs. --- .readthedocs.yaml | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 177e2ff4..2d3b743b 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -2,15 +2,9 @@ build: os: ubuntu-22.04 tools: python: '3' - jobs: - post_build: - - make reports -python: - install: - - extra_requirements: - - docs - - lint - - tests - method: pip - path: . + commands: + - pip install --upgrade pip + - make dev-docs,lint,tests + - make docs + - make reports version: 2 From 187c3b14f43dbe7b1aec410071593d2a7203f305 Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Tue, 8 Aug 2023 11:27:20 +0800 Subject: [PATCH 6/8] No redundant make reports. --- .github/workflows/release.yml | 1 - .gitlab-ci.yml | 1 - .readthedocs.yaml | 1 - Makefile | 12 +++--------- Makefile.jinja | 12 +++--------- docs/cli/index.rst | 4 ++-- docs/index.rst | 1 + docs/reports/coverage/index.rst | 4 ++++ docs/reports/index.rst | 8 ++++++++ docs/reports/mypy/index.rst | 4 ++++ 10 files changed, 25 insertions(+), 23 deletions(-) create mode 100644 docs/reports/coverage/index.rst create mode 100644 docs/reports/index.rst create mode 100644 docs/reports/mypy/index.rst diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 3766d71b..8098954e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -32,7 +32,6 @@ jobs: - run: env | sort - run: make dev-docs,lint,tests - run: make docs - - run: make reports - name: Upload pages artifact uses: actions/upload-pages-artifact@v2 with: diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index c89b5ee0..70c19755 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -72,7 +72,6 @@ pages: - env | sort - make dev-docs,lint,tests - make docs - - make reports stage: build_release release: release: diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2d3b743b..0c82a557 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,5 +6,4 @@ build: - pip install --upgrade pip - make dev-docs,lint,tests - make docs - - make reports version: 2 diff --git a/Makefile b/Makefile index a24c7e71..fdec4b1f 100644 --- a/Makefile +++ b/Makefile @@ -1,4 +1,4 @@ -.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild mypy-reports tests-reports reports +.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild # Construct pipenv run command with or without site-packages flag when not in CI environment and pipenv command exists. SITE_PACKAGES_FLAG = $(shell [ "${SS_SITE_PACKAGES}" = "true" ] && echo --site-packages) @@ -74,14 +74,8 @@ upload: docs: ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR}/html + ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/html/reports/mypy + ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/html/reports/coverage . docs-autobuild: ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR}/html --watch src - -mypy-reports: - ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/html/$@ - -tests-reports: - ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/html/$@ . - -reports: mypy-reports tests-reports diff --git a/Makefile.jinja b/Makefile.jinja index 739417e2..55bd4567 100644 --- a/Makefile.jinja +++ b/Makefile.jinja @@ -1,4 +1,4 @@ -.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild mypy-reports tests-reports reports +.PHONY: clean deepclean install dev version pre-commit lint black mypy ruff toml-sort tests freeze build upload docs docs-autobuild # Construct pipenv run command with or without site-packages flag when not in CI environment and pipenv command exists. SITE_PACKAGES_FLAG = $(shell [ "${SS_SITE_PACKAGES}" = "true" ] && echo --site-packages) @@ -76,14 +76,8 @@ upload: docs: ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR}/html - -docs-autobuild: - ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR}/html --watch src - -mypy-reports: ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/html/$@ - -tests-reports: ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/html/$@ . -reports: mypy-reports tests-reports +docs-autobuild: + ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR}/html --watch src diff --git a/docs/cli/index.rst b/docs/cli/index.rst index 2a2a7513..c3798ecb 100644 --- a/docs/cli/index.rst +++ b/docs/cli/index.rst @@ -1,5 +1,5 @@ -Command Line Interface -====================== +CLI Reference +============= .. click:: serious_scaffold.cli:typer_click_object :prog: serious-scaffold-cli diff --git a/docs/index.rst b/docs/index.rst index 84ef3dde..5141b4a6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,6 +6,7 @@ Welcome to Serious Scaffold Python's documentation! cli/index api/index + reports/index Indices and tables ================== diff --git a/docs/reports/coverage/index.rst b/docs/reports/coverage/index.rst new file mode 100644 index 00000000..95f61be3 --- /dev/null +++ b/docs/reports/coverage/index.rst @@ -0,0 +1,4 @@ +Coverage Reports +================ + +This is a placeholder for coverage reports which supposed to be overridden. diff --git a/docs/reports/index.rst b/docs/reports/index.rst new file mode 100644 index 00000000..cf491a7c --- /dev/null +++ b/docs/reports/index.rst @@ -0,0 +1,8 @@ +Code Quality Reports +==================== + +.. toctree:: + :maxdepth: 2 + + mypy/index + coverage/index diff --git a/docs/reports/mypy/index.rst b/docs/reports/mypy/index.rst new file mode 100644 index 00000000..16f27ab4 --- /dev/null +++ b/docs/reports/mypy/index.rst @@ -0,0 +1,4 @@ +MyPy Reports +============ + +This is a placeholder for mypy reports which supposed to be overridden. From f2642e13efda8a0fc8bb0ec8cbd4e5dddb5a568f Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Tue, 8 Aug 2023 11:37:39 +0800 Subject: [PATCH 7/8] Merge requirements. --- .github/workflows/release.yml | 2 +- .gitlab-ci.yml | 2 +- .gitlab-ci.yml.jinja | 2 +- .readthedocs.yaml | 2 +- requirements/docs.txt | 3 +++ requirements/lint.txt | 2 +- 6 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8098954e..70e0ba37 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -30,7 +30,7 @@ jobs: cache: pip python-version: 3.x - run: env | sort - - run: make dev-docs,lint,tests + - run: make dev-docs - run: make docs - name: Upload pages artifact uses: actions/upload-pages-artifact@v2 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 70c19755..5e3c73c9 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -70,7 +70,7 @@ pages: - /^v(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)$/ script: - env | sort - - make dev-docs,lint,tests + - make dev-docs - make docs stage: build_release release: diff --git a/.gitlab-ci.yml.jinja b/.gitlab-ci.yml.jinja index 4b00b8ba..dbdd8ac0 100644 --- a/.gitlab-ci.yml.jinja +++ b/.gitlab-ci.yml.jinja @@ -87,7 +87,7 @@ pages: - /^v(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)\.(?P0|[1-9]\d*)$/ script: - env | sort - - make dev-docs,lint,tests + - make dev-docs - make docs - make reports stage: build_release diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0c82a557..34ec0ab5 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,6 +4,6 @@ build: python: '3' commands: - pip install --upgrade pip - - make dev-docs,lint,tests + - make dev-docs - make docs version: 2 diff --git a/requirements/docs.txt b/requirements/docs.txt index 8c74bcdc..56cda99c 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,6 +1,9 @@ # Requirements for docs. autodoc-pydantic furo +mypy[reports] +pytest +pytest-cov Sphinx sphinx-autobuild sphinx-click diff --git a/requirements/lint.txt b/requirements/lint.txt index 725098a8..8b8f70fe 100644 --- a/requirements/lint.txt +++ b/requirements/lint.txt @@ -1,6 +1,6 @@ # Requirements for lint. black isort -mypy[reports] +mypy ruff toml-sort From 379c6026e95d30a6a19e084d6145741fabd0f136 Mon Sep 17 00:00:00 2001 From: Xuan Hu Date: Tue, 8 Aug 2023 11:44:04 +0800 Subject: [PATCH 8/8] Consistency. --- .gitlab-ci.yml.jinja | 1 - Makefile.jinja | 4 ++-- docs/cli/index.rst.jinja | 4 ++-- docs/index.rst.jinja | 1 + 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.gitlab-ci.yml.jinja b/.gitlab-ci.yml.jinja index dbdd8ac0..67a86af4 100644 --- a/.gitlab-ci.yml.jinja +++ b/.gitlab-ci.yml.jinja @@ -89,7 +89,6 @@ pages: - env | sort - make dev-docs - make docs - - make reports stage: build_release release: release: diff --git a/Makefile.jinja b/Makefile.jinja index 55bd4567..caf006c2 100644 --- a/Makefile.jinja +++ b/Makefile.jinja @@ -76,8 +76,8 @@ upload: docs: ${PIPRUN} python -m sphinx.cmd.build docs ${PUBLIC_DIR}/html - ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/html/$@ - ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/html/$@ . + ${PIPRUN} python -m mypy tests src --html-report ${PUBLIC_DIR}/html/reports/mypy + ${PIPRUN} python -m pytest --cov-report html:${PUBLIC_DIR}/html/reports/coverage . docs-autobuild: ${PIPRUN} python -m sphinx_autobuild docs ${PUBLIC_DIR}/html --watch src diff --git a/docs/cli/index.rst.jinja b/docs/cli/index.rst.jinja index da395198..47c8c1cf 100644 --- a/docs/cli/index.rst.jinja +++ b/docs/cli/index.rst.jinja @@ -1,5 +1,5 @@ -Command Line Interface -====================== +CLI Reference +============= .. click:: {{ module_name }}.cli:typer_click_object :prog: {{ package_name }}-cli diff --git a/docs/index.rst.jinja b/docs/index.rst.jinja index 0f5643a2..3b727a8b 100644 --- a/docs/index.rst.jinja +++ b/docs/index.rst.jinja @@ -6,6 +6,7 @@ Welcome to {{ project_name }}'s documentation! cli/index api/index + reports/index Indices and tables ==================