Skip to content

Commit

Permalink
Update documentation dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
Luthaf committed Dec 19, 2023
1 parent 2836e9e commit ce6fb8b
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# sphinx dependencies
sphinx < 7.2 # breathe is not compatible with sphinx 7.2 yet
# sphinx and dependencies
sphinx == 7.2.6
furo # sphinx theme
breathe >=4.33 # C and C++ => sphinx through doxygen
sphinx-gallery # convert python files into nice documentation
Expand Down
1 change: 1 addition & 0 deletions docs/src/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
examples
sg_execution_times.rst
8 changes: 6 additions & 2 deletions docs/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,11 @@ def setup(app):
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["Thumbs.db", ".DS_Store"]
exclude_patterns = [
"Thumbs.db",
".DS_Store",
"sg_execution_times.rst",
]


autoclass_content = "both"
Expand All @@ -120,7 +124,7 @@ def setup(app):
"filename_pattern": "/*",
"examples_dirs": ["../../python/rascaline/examples"],
"gallery_dirs": ["examples"],
"min_reported_time": 60,
"min_reported_time": 5,
# Make the code snippet for rascaline functions clickable
"reference_url": {"rascaline": None},
"prefer_full_module": ["rascaline"],
Expand Down
2 changes: 2 additions & 0 deletions scripts/clean-python.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ cd "$ROOT_DIR"
rm -rf dist
rm -rf build
rm -rf .coverage
rm -rf docs/build
rm -rf docs/src/examples

rm -rf python/rascaline-torch/dist
rm -rf python/rascaline-torch/build
Expand Down
1 change: 0 additions & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,6 @@ commands =
# install rascaline-torch
pip install python/rascaline-torch --no-deps --no-build-isolation --force-reinstall

bash -c "rm -rf docs/src/examples"
sphinx-build {posargs:-E} -W -b html docs/src docs/build/html


Expand Down

0 comments on commit ce6fb8b

Please sign in to comment.