Skip to content

Commit 7af58bd

Browse files
committed
Update deployer workflow and docs configuration
1 parent 3224401 commit 7af58bd

File tree

2 files changed

+24
-14
lines changed

2 files changed

+24
-14
lines changed

.github/workflows/sphinx-build.yml

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,25 @@ on:
77

88
jobs:
99
docs:
10-
runs-on: ubuntu-18.04
10+
runs-on: ubuntu-latest
1111
steps:
12-
- uses: actions/checkout@v2
12+
- uses: actions/checkout@v4
1313

1414
- name: Setup miniconda
15-
uses: conda-incubator/setup-miniconda@v2
15+
uses: conda-incubator/setup-miniconda@v3
1616
with:
1717
auto-update-conda: true
18-
python-version: 3.7
18+
python-version: 3.10
1919

20-
- name: Conda install dependecies
20+
- name: Conda install dependencies
2121
shell: bash -l {0}
22-
run: conda install --yes -c conda-forge pythonocc-core=7.4.0 numpy scipy matplotlib vtk nose setuptools coveralls sphinx_rtd_theme sphinx python=3.7
22+
run: conda install --yes -c conda-forge pythonocc-core numpy scipy matplotlib vtk nose setuptools coveralls sphinx_rtd_theme sphinx python=3.10
2323

2424
- name: Conda info
2525
shell: bash -l {0}
2626
run: conda info
2727

28-
- name: Conda info
28+
- name: Build Documentation
2929
shell: bash -l {0}
3030
run: cd docs && sphinx-build -b html -d build/doctrees --keep-going --no-color -w '/tmp/sphinx-log' source build/html
3131

@@ -44,3 +44,13 @@ jobs:
4444
#deploy_key: ${{ secrets.DEPLOY_PRIVATE_KEY }}
4545
publish_dir: ./docs/build/html
4646
allow_empty_commit: true
47+
48+
release_github:
49+
runs-on: ubuntu-latest
50+
permissions:
51+
contents: write
52+
steps:
53+
- uses: actions/checkout@v4
54+
- uses: ncipollo/release-action@v1
55+
with:
56+
token: ${{ secrets.GITHUB_TOKEN }}

docs/source/conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@
4545
]
4646

4747
intersphinx_mapping = {
48-
"python": ("http://docs.python.org/3", None),
49-
"numpy": ("http://docs.scipy.org/doc/numpy/", None),
50-
"scipy": ("http://docs.scipy.org/doc/scipy/reference/", None),
51-
"matplotlib": ("http://matplotlib.sourceforge.net/", None),
48+
"python": ("https://docs.python.org/3", None),
49+
"numpy": ("https://numpy.org/doc/stable/", None),
50+
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
51+
"matplotlib": ("https://matplotlib.org/stable", None),
5252
}
5353

5454
# Add any paths that contain templates here, relative to this directory.
@@ -87,7 +87,7 @@
8787
#
8888
# This is also used if you do content translation via gettext catalogs.
8989
# Usually you set "language" from the command line for these cases.
90-
language = None
90+
language = "en"
9191

9292
# There are two options for replacing |today|: either, you set today to some
9393
# non-false value, then it is used:
@@ -133,7 +133,7 @@
133133
# classes and attributes. As side effects, this option ... ???
134134
# If false, ... ???.
135135
# The default is True.
136-
viewcode_import = True
136+
# viewcode_import = True
137137

138138

139139
# -- Options for HTML output ----------------------------------------------
@@ -149,7 +149,7 @@
149149
# html_theme_options = {}
150150

151151
# Add any paths that contain custom themes here, relative to this directory.
152-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
152+
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
153153

154154
# The name for this set of Sphinx documents. If None, it defaults to
155155
# "<project> v<release> documentation".

0 commit comments

Comments
 (0)