-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Jason C. Nucciarone <[email protected]>
- Loading branch information
0 parents
commit 27e5684
Showing
38 changed files
with
3,269 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: Main Documentation Checks | ||
|
||
on: | ||
- push | ||
- pull_request | ||
- workflow_dispatch | ||
|
||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.ref }} | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
documentation-checks: | ||
uses: canonical/documentation-workflows/.github/workflows/documentation-checks.yaml@main | ||
with: | ||
working-directory: '.' |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
/*env*/ | ||
.sphinx/venv/ | ||
.sphinx/requirements.txt | ||
.sphinx/warnings.txt | ||
.sphinx/.wordlist.dic | ||
.sphinx/.doctrees/ | ||
.sphinx/node_modules/ | ||
package*.json | ||
_build | ||
.DS_Store | ||
__pycache__ | ||
.idea/ | ||
.vscode/ | ||
.sphinx/styles/* | ||
.sphinx/vale.ini |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.11" | ||
jobs: | ||
pre_install: | ||
- python3 .sphinx/build_requirements.py | ||
- git fetch --unshallow || true | ||
|
||
# Build documentation in the docs/ directory with Sphinx | ||
sphinx: | ||
builder: dirhtml | ||
configuration: conf.py | ||
fail_on_warning: true | ||
|
||
# If using Sphinx, optionally build your docs in additional formats such as PDF | ||
formats: | ||
|
||
# Optionally declare the Python requirements required to build your docs | ||
python: | ||
install: | ||
- requirements: .sphinx/requirements.txt |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.