Skip to content

Commit 1f3bda2

Browse files
committed
Fix doc options in CI
1 parent d300b71 commit 1f3bda2

File tree

4 files changed

+6
-3
lines changed

4 files changed

+6
-3
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
- name: Build documentation
3232
env:
3333
READTHEDOCS: 'True'
34-
run: SPHINXOPTS='-nW' make -C doc html
34+
run: make SPHINXOPTS='-nW' -C doc html
3535
- uses: actions/upload-artifact@v2
3636
with:
3737
name: doc-build

.github/workflows_source/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
- name: Build documentation
4949
env:
5050
READTHEDOCS: "True"
51-
run: SPHINXOPTS='-nW' make -C doc html
51+
run: make SPHINXOPTS='-nW' -C doc html
5252
- uses: actions/upload-artifact@v2
5353
with:
5454
name: doc-build

doc/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,13 @@
4141

4242
intersphinx_mapping = {
4343
"python": ("https://docs.python.org/3", None),
44+
"numpy": ("https://numpy.org/devdocs/", None),
4445
"symmetry-representation": ("http://z2pack.ethz.ch/symmetry-representation/", None),
4546
"fsc.hdf5-io": ("http://frescolinogroup.github.io/frescolino/pyhdf5io/0.5/", None),
4647
}
4748

4849
nitpick_ignore = [("py:class", "array")]
50+
nitpick_ignore_regex = [("py:class", "numpy.*"), ("py:class", "ty.*")]
4951
ipython_warning_is_error = False
5052

5153
# Add any paths that contain templates here, relative to this directory.

doc/source/symmetrize.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The model is located in the ``examples`` directory of the TBmodels source. You w
3232
.. ipython::
3333

3434
In [0]: model_nosym = tbmodels.io.load(
35-
...: EXAMPLES_DIR / 'symmetrization' / 'nonsymmorphic_Si'/'data' / 'model_nosym.hdf5'
35+
...: EXAMPLES_DIR / 'symmetrization' / 'nonsymmorphic_Si' / 'data' / 'model_nosym.hdf5'
3636
...: )
3737

3838

@@ -114,6 +114,7 @@ Note that we use the ``numeric=True`` flag here. This keyword is used to switch
114114
Next, we use ``pymatgen`` to determine the space group symmetries of our crystal:
115115

116116
.. ipython::
117+
:okwarning:
117118

118119
In [0]: from pymatgen.core import Structure
119120
...: from pymatgen.symmetry.analyzer import SpacegroupAnalyzer

0 commit comments

Comments
 (0)