Skip to content

Commit

Permalink
update docs files
Browse files Browse the repository at this point in the history
  • Loading branch information
gschwend committed Dec 11, 2024
1 parent 7991492 commit fb97832
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 25 deletions.
44 changes: 22 additions & 22 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -103,25 +103,25 @@ repos:
# notebooks from the docs, so users don't have to wait through the execution
# of each notebook or each commit. By default, these will be checked in the
# GitHub workflows.
# - repo: local
# hooks:
# - id: sphinx-build
# name: Build documentation with Sphinx
# entry: sphinx-build
# language: system
# always_run: true
# exclude_types: [file, symlink]
# args:
# [
# "-M", # Run sphinx in make mode, so we can use -D flag later
# # Note: -M requires next 3 args to be builder, source, output
# "html", # Specify builder
# "./docs", # Source directory of documents
# "./build", # Output directory for rendered documents
# "-T", # Show full trace back on exception
# "-E", # Don't use saved env; always read all files
# "-d", # Flag for cached environment and doctrees
# "./docs/build/doctrees", # Directory
# "-D", # Flag to override settings in conf.py
# "exclude_patterns=notebooks/*.ipynb", # Exclude our notebooks from pre-commit
# ]
- repo: local
hooks:
- id: sphinx-build
name: Build documentation with Sphinx
entry: sphinx-build
language: system
always_run: true
exclude_types: [file, symlink]
args:
[
"-M", # Run sphinx in make mode, so we can use -D flag later
# Note: -M requires next 3 args to be builder, source, output
"html", # Specify builder
"./docs", # Source directory of documents
"./build", # Output directory for rendered documents
"-T", # Show full trace back on exception
"-E", # Don't use saved env; always read all files
"-d", # Flag for cached environment and doctrees
"./docs/build/doctrees", # Directory
"-D", # Flag to override settings in conf.py
"exclude_patterns=notebooks/*.ipynb", # Exclude our notebooks from pre-commit
]
4 changes: 1 addition & 3 deletions docs/nbs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,4 @@ Notebooks

.. toctree::

Introducing Pz Server lib <notebooks/rst/0_introduction.rst>
Specz Catalogs <notebooks/rst/1_specz_catalogs.rst>
Training Sets <notebooks/rst/2_training_sets.rst>
Tutorial introducing PZ Server lib <notebooks/rst/pzserver_tutorial.rst>

0 comments on commit fb97832

Please sign in to comment.