-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #119 from RTIInternational/112-add-documentation
112 add documentation
- Loading branch information
Showing
133 changed files
with
5,396 additions
and
1,745 deletions.
There are no files selected for viewing
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,33 @@ | ||
name: documentation | ||
|
||
on: | ||
push: | ||
tags: [ 'v*.*.*' ] | ||
# branches: [112-add-documentation] | ||
|
||
permissions: | ||
contents: write | ||
|
||
jobs: | ||
docs: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- uses: actions/setup-python@v3 | ||
with: | ||
python-version: "3.10" | ||
|
||
- name: Install dependencies | ||
run: | | ||
python -m pip install --upgrade pip | ||
pip install sphinx pydata-sphinx-theme myst-nb sphinx-design sphinx-autoapi numpydoc ghp-import -e . | ||
- name: Sphinx build | ||
run: | | ||
cd docs/sphinx | ||
make clean html | ||
- name: Run ghp-import | ||
run: | | ||
ghp-import -n -p -f docs/sphinx/_build/html |
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
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,14 @@ | ||
repos: | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v4.5.0 | ||
hooks: | ||
- id: trailing-whitespace | ||
- id: end-of-file-fixer | ||
- id: check-yaml | ||
args: [--allow-multiple-documents] | ||
- id: check-added-large-files | ||
args: ['--maxkb=13000', '--enforce-all'] | ||
- repo: https://github.com/numpy/numpydoc | ||
rev: v1.6.0 | ||
hooks: | ||
- id: numpydoc-validation |
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 |
---|---|---|
|
@@ -3,4 +3,4 @@ | |
"PYTHONPATH": "${workspaceFolder}/src" | ||
}, | ||
"files.trimTrailingWhitespace": true, | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
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
This file was deleted.
Oops, something went wrong.
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,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line, and also | ||
# from the environment for the first two. | ||
SPHINXOPTS ?= | ||
SPHINXBUILD ?= sphinx-build | ||
SOURCEDIR = . | ||
BUILDDIR = _build | ||
|
||
# Put it first so that "make" without argument is like "make help". | ||
help: | ||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | ||
|
||
.PHONY: help Makefile | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: Makefile | ||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) |
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,70 @@ | ||
/* Override some aspects of the pydata-sphinx-theme */ | ||
|
||
:root { | ||
/* Use softer blue from bootstrap's default info color */ | ||
--pst-color-info: 23, 162, 184; | ||
} | ||
|
||
table { | ||
width: auto; /* Override fit-content which breaks Styler user guide ipynb */ | ||
} | ||
|
||
/* Main index page overview cards */ | ||
|
||
.intro-card { | ||
padding: 30px 10px 20px 10px; | ||
} | ||
|
||
.intro-card .sd-card-img-top { | ||
margin: 10px; | ||
height: 52px; | ||
background: none !important; | ||
} | ||
|
||
.intro-card .sd-card-title { | ||
color: var(--pst-color-primary); | ||
font-size: var(--pst-font-size-h5); | ||
padding: 1rem 0rem 0.5rem 0rem; | ||
} | ||
|
||
.intro-card .sd-card-footer { | ||
border: none !important; | ||
} | ||
|
||
.intro-card .sd-card-footer p.sd-card-text { | ||
max-width: 220px; | ||
margin-left: auto; | ||
margin-right: auto; | ||
} | ||
|
||
.intro-card .sd-btn-secondary { | ||
background-color: #6c757d !important; | ||
border-color: #6c757d !important; | ||
} | ||
|
||
.intro-card .sd-btn-secondary:hover { | ||
background-color: #5a6268 !important; | ||
border-color: #545b62 !important; | ||
} | ||
|
||
.card, .card img { | ||
background-color: var(--pst-color-background); | ||
} | ||
|
||
.ciroh-card { | ||
margin: 10px; | ||
height: 140px; | ||
background: none !important; | ||
} | ||
|
||
html[data-theme="dark"] { | ||
h1 { | ||
color: rgb(138, 189, 216); | ||
} | ||
h2 { | ||
color: rgb(138, 189, 216); | ||
} | ||
h3 { | ||
color: rgb(138, 189, 216); | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.