Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx use myst-nb #830

Merged
merged 48 commits into from
Jan 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
98486f6
convert changelog to myst
marscher Dec 19, 2022
a546dc6
conv readme
marscher Dec 19, 2022
1cbc8b8
conv
marscher Dec 19, 2022
d598693
mv src files to src sub dir
marscher Dec 19, 2022
b943a05
mv tutorials to doc/
marscher Dec 19, 2022
1715c66
mv makefile to doc/
marscher Dec 19, 2022
e4cfb9e
fix path
marscher Dec 19, 2022
53d39b3
use myst include directive
marscher Dec 19, 2022
bdb081c
[conf] wip
marscher Dec 19, 2022
1eca269
fix badges
marscher Dec 19, 2022
f752b56
inc
marscher Dec 19, 2022
55bc73f
syntax highlighting
marscher Dec 19, 2022
1c7cc90
mv to src
marscher Dec 19, 2022
800588e
fix Makefile
marscher Dec 19, 2022
15aad03
clean up gitignore
marscher Dec 19, 2022
a054d2d
add tutorials.md
marscher Dec 19, 2022
95e666b
[sphinx] only include myst_nb extension
marscher Dec 19, 2022
0cefbe6
clean up Makefile
marscher Dec 19, 2022
0f40792
update rtd env
marscher Dec 19, 2022
2b5e7a2
updated gitignore
marscher Dec 19, 2022
aa0d407
fix refs
marscher Dec 19, 2022
b11bdb5
set cache path, removed nbsphinx
marscher Dec 19, 2022
6f23d3d
2 jobs
marscher Dec 19, 2022
38156a2
fix warning
marscher Dec 19, 2022
d29cf83
Merge branch 'master' into myst
marscher Dec 19, 2022
8099f36
added symlink to tutorials
marscher Dec 19, 2022
640cf3c
Merge remote-tracking branch 'origin/master' into myst
marscher Jan 6, 2023
842ac11
upper case starting sections
marscher Jan 6, 2023
f95807e
Merge branch 'master' into myst
marscher Jan 16, 2023
9a3540d
[gha/static_analysis] mypy only checks source folder
marscher Jan 17, 2023
f998edf
ignore RUF101 in conf.py
marscher Jan 17, 2023
2e1d369
Merge branch 'master' into myst
marscher Jan 25, 2023
6314f8a
amend changelog
marscher Jan 25, 2023
37da24e
[gha/docs] fix path
marscher Jan 25, 2023
5b9984f
[sphinx/conf] updated source suffixes
marscher Jan 25, 2023
a3f3d24
pin sphinx-autodoc-typehints :pray:
marscher Jan 26, 2023
d14e282
format
marscher Jan 26, 2023
05ecef7
update changelog action
marscher Jan 26, 2023
4ad3f69
do not link to tutorials, just refer to them as plain text.
marscher Jan 26, 2023
8ecbe94
add plugin to render json as raw html
marscher Jan 26, 2023
ff583ce
install plugin in rtd_env
marscher Jan 26, 2023
6d50923
fix link
marscher Jan 26, 2023
b661910
clean up
marscher Jan 26, 2023
991bb22
Revert "fix link"
marscher Jan 26, 2023
a13c9f5
fix path
marscher Jan 26, 2023
db49c8d
increase nb execution timeout
marscher Jan 26, 2023
21caab0
[rtd] fix conf path
marscher Jan 26, 2023
c9cdd81
pin docutils >=0.19
marscher Jan 26, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .flake8
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ max-line-length = 88
select = C,E,F,W,B,B950 # black formatting options
exclude =
__init__.py
doc/conf.py
doc/src/conf.py
no-accept-encodings = True
4 changes: 2 additions & 2 deletions .github/workflows/changelog.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v3
- name: Grep for PR number in CHANGELOG.rst
run: grep -P ':pull:`${{github.event.number}}`' CHANGELOG.rst
- name: Grep for PR number in CHANGELOG.md
run: grep -P '{pull}`${{github.event.number}}`' CHANGELOG.md
6 changes: 1 addition & 5 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,8 @@ jobs:
- name: install weldx kernel
run: ipython kernel install --user --name=weldx

- name: set notebook execution
if: (github.event_name == 'workflow_dispatch')
run: echo "nbsphinx_execute=${{ github.event.inputs.nbsphinx_execute }}" >> $GITHUB_ENV

- name: Build docs
run: sphinx-build -W -n -b html -d build/doctrees doc build/html --keep-going -j 2 -D nbsphinx_execute=${{ env.nbsphinx_execute }}
run: sphinx-build -W -n -b html -d build/doctrees doc/src build/html --keep-going -j 2

- uses: actions/upload-artifact@v3
if: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/static_analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,4 @@ jobs:

- name: run mypy
run: |
mypy --install-types --non-interactive .
mypy --install-types --non-interactive weldx/
4 changes: 0 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,6 @@ instance/
# Scrapy stuff:
.scrapy

# Sphinx documentation
doc/_build/
build/

# PyBuilder
target/

Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ repos:
rev: v2.2.2
hooks:
- id: codespell
exclude: doc/legal-notice.rst
exclude: doc/src/legal-notice.md
args:
- -L ro
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ build:
# Build documentation in the doc/ directory with Sphinx
sphinx:
builder: html
configuration: doc/conf.py
configuration: doc/src/conf.py
fail_on_warning: true
#
## List of submodules to be included.
Expand Down
Loading