From fe7d4082f3b2c2742a84cc8e6fbfd7ed6ce5faa8 Mon Sep 17 00:00:00 2001 From: Cristiano Singulani Date: Wed, 11 Dec 2024 13:12:46 -0300 Subject: [PATCH] Changed build doc (#128) --- .github/workflows/build-documentation.yml | 2 +- .pre-commit-config.yaml | 40 +++++++++++------------ 2 files changed, 21 insertions(+), 21 deletions(-) diff --git a/.github/workflows/build-documentation.yml b/.github/workflows/build-documentation.yml index c2607e4..f96ba52 100644 --- a/.github/workflows/build-documentation.yml +++ b/.github/workflows/build-documentation.yml @@ -30,7 +30,7 @@ jobs: sudo apt-get install pandoc - name: Build docs run: | - sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html -D exclude_patterns="notebooks/*.ipynb" + sphinx-build -T -E -b html -d docs/build/doctrees ./docs docs/build/html -D exclude_patterns="notebooks/*/*.ipynb" - name: Run ghp-import run: | ghp-import -n -p -f -x docs/ docs/build/html \ No newline at end of file diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 2a7a9eb..182ecb4 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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 + - 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 + - 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 ]