chore: use Canonical's sphinx-docs-starter-pack #197
Merged
Conversation
This file contains 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
tigarmo
force-pushed
the
CRAFT-2175-craft-cli-starter-pack
branch
from
8aa7c6c to
d9b188f
Compare
Codecov Report
@@ Coverage Diff @@
## main #197 +/- ##
=======================================
Coverage 94.73% 94.73%
=======================================
Files 7 7
Lines 1063 1063
Branches 194 194
=======================================
Hits 1007 1007
Misses 53 53
Partials 3 3 |
tigarmo
force-pushed
the
CRAFT-2175-craft-cli-starter-pack
branch
2 times, most recently
from
f366818 to
0da9e4e
Compare
This commit adds Canonical's starter pack for Sphinx documentation. Notes: - Doc-related dependencies are listed in a requirements file, so we drop those optional-deps from pyproject.toml. Extra deps are added to docs/.sphinx/requirements.txt. - The docs/.readthedocs.yaml file is altered to allow warnings (the docs generation from the generates harmless warnings). Fixes #187
tigarmo
force-pushed
the
CRAFT-2175-craft-cli-starter-pack
branch
2 times, most recently
from
2b1d15e to
7971bca
Compare
syu-w
approved these changes
Oct 31, 2023
mr-cal
approved these changes
Oct 31, 2023
yeah I figured I'd keep it simple and follow the instructions on the starter-pack site. I hope that next time we "need" to update this it'll be with a proper package hehe |
- fix spelling and update custom wordlist - chore: make linkcheck ignore an internal reference - fix various yaml formatting issues - don't run the doc linting workflow twice - chore: disabled autonamedtuple extension: The problem: when running in Python3.8, the autonamedtuple extension (part of sphinx-toolbox) fails to eval newer-style type annotations (like "type[X]" instead of "typing.Type[X]"), even if the Python module that has said code has the correct __future__ annotations. This affects us because the documentation linters on CI run on Ubuntu 20.04, which has Python 3.8 by default. So the quicker fix here is to disable the extension by instead enabling everything else in the toolbox manually.
tigarmo
force-pushed
the
CRAFT-2175-craft-cli-starter-pack
branch
from
7971bca to
54a895b
Compare
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.
This commit adds Canonical's starter pack for Sphinx documentation. A consequence of this is that the doc-related dependencies are listed in a requirements file, so we drop those optional-deps from pyproject.toml.
Fixes #187
tox?