Skip to content

Commit 6a46f8c

Browse files
committed
chore: using pdoc instead of pdoc3 for doc build
We cannot support repos that clearly engage into backhanded tactics: pdoc3/pdoc#64
1 parent 5f55216 commit 6a46f8c

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

kalash/__init__.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@
1010
.. include:: ./pdoc/contributing.md
1111
.. include:: ./pdoc/trailer.md
1212
"""
13-
13+
__docformat__ = "restructuredtext"
1414
__version__ = "4.0.0"

kalash/run.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -378,7 +378,7 @@ def make_loader_and_trigger_object(
378378
def docs():
379379
"""Open bundled documentation in the web browser."""
380380
base_dir = os.path.dirname(__file__)
381-
rel_docpath = ['built_docs', 'html', 'kalash', 'index.html']
381+
rel_docpath = ['built_docs', 'kalash.html']
382382
docpath = os.path.join(base_dir, *rel_docpath)
383383
_platform = platform.system()
384384
if _platform == "Darwin" or "Linux":

noxfile.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ class Tasks:
2626
coverage = lambda posargs: f'coverage {posargs}'
2727
build_wheel = 'python -m setup bdist_wheel'
2828
send = r'twine upload dist/*.whl -u __token__ -p'
29-
docs = 'pdoc --html kalash --force'
29+
docs = 'pdoc kalash -o .'
3030
quality = 'flake8'
3131

3232

@@ -100,7 +100,7 @@ def docs(session: nox.Session):
100100
if not os.path.exists(built_docs_dir):
101101
os.makedirs(built_docs_dir)
102102
_copy_and_sanitize_paths_for_pdoc3('kalash/doc', pdoc_dir)
103-
session.install('pdoc3', '.')
103+
session.install('pdoc', '.')
104104
cwd = os.getcwd()
105105
session.chdir(built_docs_dir)
106106
session.run(*split_cmd(Tasks.docs))

0 commit comments

Comments
 (0)