summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #2684 from clint-lawrence/patch-1Jason R. Coombs2021-05-291-1/+1
|\ | | | | Fix a broken external link
| * Fix a broken external linkclint-lawrence2021-05-251-1/+1
| |
* | Entrypoints in declarative config are now supportedNicolas CANIART2021-05-291-57/+89
|/ | | | | | The documentation still states it is not though. Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
* Merge pull request #2668 from carltongibson/c/fix-example-indentJason R. Coombs2021-05-191-2/+2
|\ | | | | Corrected tabs for spaces in quickstart example.
| * Corrected tabs for spaces in quickstart example.Carlton Gibson2021-05-101-2/+2
| |
* | Merge pull request #2672 from luzpaz/typosJason R. Coombs2021-05-194-7/+7
|\ \ | | | | | | Fix misc. doc typos
| * | Fix misc. doc typosluz paz2021-05-144-7/+7
| |/ | | | | Found via `codespell`
* | Merge pull request #2676 from hugovk/patch-1Jason R. Coombs2021-05-191-2/+1
|\ \ | | | | | | Docs: Use license_files instead of license_file
| * | Docs: Use license_files instead of license_fileHugo van Kemenade2021-05-191-2/+1
| |/
* | Avoid publishing unreleased changes when there are none.Jason R. Coombs2021-05-191-0/+2
| |
* | Remove seemingly unneeded settings.Jason R. Coombs2021-05-091-13/+2
| |
* | Merge branch 'main' into docs/towncrier-upgradeJason R. Coombs2021-05-091-4/+5
|\ \ | |/
| * Merge pull request #2634 from carltongibson/c/fix-quickstart-linkJason R. Coombs2021-05-091-2/+3
| |\ | | | | | | Fixed quickstart packaging resources hyperlink.
| | * Fixed quickstart packaging resources hyperlink.Carlton Gibson2021-04-101-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | The implicit link target that should have been created from the title was not being detected correctly. This was causing the link to be interpreted as an external hyperlink reference, resulting in a 404 in the rendered docs. Adding the explicit target and `ref` allows the link to resolve correctly.
| * | Merge pull request #2637 from carltongibson/c/fix-example-indentJason R. Coombs2021-05-091-2/+2
| |\ \ | | | | | | | | Corrected indent in setup.cfg example.
| | * | Corrected indent in setup.cfg example.Carlton Gibson2021-04-121-2/+2
| | |/
* | | Display changelog for unreleased version in docsSviatoslav Sydorenko2021-05-052-0/+18
|/ /
* | Merge https://github.com/jaraco/skeletonJason R. Coombs2021-05-041-3/+3
|\ \
| * | Make sphinx fail on any warnings (#36)Sviatoslav Sydorenko2021-04-251-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This change adds `nitpicky=True` (which is an equivalent of `-n`) to make Sphinx emit warnings for any references to non-existing targets. Then, it adds `-W` to make it fail whenever a single warning is seen. Finally, `--keep-going` allows Sphinx to print out all the warnings before exiting instead of showing just one and bailing. Resolves #29 Refs: * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-n * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W * https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-keep-going
| * | Automatically inject project name in docs heading.Jason R. Coombs2020-12-291-2/+2
| | |
* | | Fix doc builds for intersphinx mapping. Supersedes #2659.Jason R. Coombs2021-05-041-4/+4
| | |
* | | Merge branch 'main' into feature/distutils-docsJason R. Coombs2021-04-2513-283/+320
|\ \ \ | | |/ | |/|
| * | Small changesMarc Mueller2021-04-031-1/+0
| | |
| * | Add documentation + changelog entriesMarc Mueller2021-04-032-1/+13
| | |
| * | Merge pull request #2626 from Yhg1s/patch-1Jason R. Coombs2021-04-031-1/+1
| |\ \ | | | | | | | | Fix typo in setup.py example in quickstart guide.
| | * | Update quickstart.rstT. Wouters2021-03-291-1/+1
| | | |
| | * | Fix typo in setup.py example in quickstart guide.T. Wouters2021-03-291-1/+1
| | | |
| * | | Merge pull request #2623 from Zedeldi/patch-1Jason R. Coombs2021-04-031-4/+4
| |\ \ \ | | | | | | | | | | Update dependency_management.rst
| | * | | Update dependency_management.rstZack Didcott2021-03-291-4/+4
| | |/ / | | | | | | | | Fix spelling and grammar
| * | | Officially declare pkg_resources as deprecated. Closes #2531.Jason R. Coombs2021-04-031-0/+7
| | | |
| * | | Section for 'find' and 'find_namespace' options is 'options.packages.find'. ↵Jason R. Coombs2021-03-301-1/+1
| |/ / | | | | | | | | | Fixes #2406.
| * | Reset RTD config to match skeleton and rely on package metadata for docs ↵Jason R. Coombs2021-03-271-8/+0
| | | | | | | | | | | | build requirements.
| * | Pin to upstream main branch for sphinx-inline-tabs. Workaround for #2614.Jason R. Coombs2021-03-271-1/+1
| | |
| * | Merge pull request #2584 from amy-lei/tabbed-codeJason R. Coombs2021-03-055-160/+227
| |\ \ | | | | | | | | Add mechanism for comparison of setup.py and its equivalent setup.cfg
| | * | Extend extensions later in the file. Fixes flake8 failure and isolates the ↵Jason R. Coombs2021-03-051-1/+4
| | | | | | | | | | | | | | | | (sole) change from other concerns.
| | * | Replace adjacent code blocks with tabbed containersAmy2021-02-283-160/+223
| | | |
| | * | Add sphinx-inline-tabs extensionAmy2021-02-282-1/+2
| | | |
| * | | Term is builder.Jason R. Coombs2021-02-281-2/+2
| | | |
| * | | Merge pull request #2552 from hexagonrecursion/patch-1Jason R. Coombs2021-02-282-4/+7
| |\ \ \ | | | | | | | | | | quickstart: recommend PyPA build instead of pep517.build
| | * | | quickstart: recommend PyPA build instead of pep517.buildAndrey Bienkowski2021-02-092-4/+7
| | |/ / | | | | | | | | | | | | see https://github.com/pypa/pep517/issues/91
| * | | Merge pull request #2561 from pwoolvett/fix/2553Jason R. Coombs2021-02-251-0/+13
| |\ \ \ | | | | | | | | | | docs(userguide): Marker example for extras_require
| | * | | docs(userguide): Marker example for extras_requirePablo Woolvett2021-02-041-0/+13
| | |/ / | | | | | | | | | | | | Signed-off-by: Pablo Woolvett <pablowoolvett@gmail.com>
| * | | Add ini to display code block in docThea2021-02-241-1/+1
| | | |
| * | | Reference index in the userguide directoryThea2021-02-201-1/+1
| | | |
| * | | Include link to new developer guide in the old oneThea2021-02-201-1/+1
| |/ /
| * | Remove bootstrap from docs buildJason R. Coombs2021-01-191-16/+0
| | |
| * | Merge pull request #2506 from xdhmoore/patch-1Jason R. Coombs2021-01-161-3/+3
| |\ \ | | | | | | | | Clarify Development Mode first paragraph
| | * | Clarify Development Mode first paragraphDaniel Moore2020-12-231-3/+3
| | | |
| * | | Merge pull request #2507 from drewrisinger/patch-1Jason R. Coombs2021-01-161-1/+1
| |\ \ \ | | | | | | | | | | docs (build_meta): fix spelling mistake
| | * | | docs (build_meta): fix spelling mistakeDrew2020-12-251-1/+1
| | |/ /