Skip to content

Commit

Permalink
testing: pdoc fix
Browse files Browse the repository at this point in the history
  • Loading branch information
lyie28 committed Nov 13, 2023
1 parent e184ae4 commit 18c287e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions client/blindai/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
__all__ = ["core", "api"]
__pdoc__ = {'api': False}

from . import core, api
2 changes: 1 addition & 1 deletion docs/generate_api_reference.sh
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ set -e # Exit if any command fails
pip install pdoc3

# Generate HTML documentation
pdoc --html --skip-errors --template-dir docs/pdoc_template -o client/blindai/audio.py client/blindai/client.py client/blindai/core.py client/blindai/utils.py client/blindai/testing.py --force
pdoc --html --skip-errors --template-dir docs/pdoc_template -o docs/blindai --force

# Remove pdoc3 version reference from generated HTML files
sed -i '/<p>Generated by <a href="https:\/\/pdoc3.github.io\/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc<\/cite> 0.10.0<\/a>.<\/p>/d' docs/blindai/*.html
Expand Down

0 comments on commit 18c287e

Please sign in to comment.