Skip to content

Commit

Permalink
self review
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Sep 24, 2024
1 parent 49d782b commit d7bfd82
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/ci.py → .github/doxygen.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from pathlib import Path
import json

DOCS_DIR = Path(__file__).parent
DOCS_DIR = Path(__file__).parent.parent / "docs"
PROPERTIES = DOCS_DIR.parent / "library.json"
CONFIG = DOCS_DIR / "Doxyfile"
TMP = DOCS_DIR / "doxygenAction"
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@ __pycache__/
*.pyc
*.egg*
build/
_build/
*CMakeUserPresets*.json
*.tar.gz

Expand Down
11 changes: 1 addition & 10 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,19 +24,10 @@ build:
tar xf doxygen.tar &&
mv doxygen-$DOXYGEN_VERSION/bin/doxygen ./
# get lib version & overwrite Doxyfile values
- python3 docs/ci.py
- python3 .github/doxygen.py
# run doxygen
- cd docs && ../.doxygen/doxygen
# copy output to RTD output path for HTML files
- ls -R docs/html/
- mkdir -p ${READTHEDOCS_OUTPUT}
- mv docs/html/ "${READTHEDOCS_OUTPUT}"

# # Build documentation in the docs/ directory with Sphinx
# sphinx:
# configuration: docs/sphinx/conf.py

# # install Python requirements required to build docs
# python:
# install:
# - requirements: docs/sphinx/requirements.txt

0 comments on commit d7bfd82

Please sign in to comment.