Skip to content

Commit 0537590

Browse files
committed
Update documentation configuration.
1 parent 5cc9083 commit 0537590

File tree

4 files changed

+17
-5
lines changed

4 files changed

+17
-5
lines changed

.hgignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
\.(py[co]|log|zip|coverage)$
1+
\.(py[co]|log|zip|coverage|json)$
22
tests/run/
33
tests/keys/random_seed
44
docs/(_build|themes)/

CHANGES.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,11 @@ Released: Not yet.
1111
- Use version comparison logic for python_full_version. Thanks to Albert
1212
Peschar for the patch.
1313

14+
- scripts
15+
16+
- Fix shebang computation for source builds of Python. Thanks to Eli
17+
Schwartz for the patch.
18+
1419
0.3.6
1520
~~~~~
1621

docs/Makefile

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ PAPEROPT_a4 = -D latex_paper_size=a4
1212
PAPEROPT_letter = -D latex_paper_size=letter
1313
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
1414

15-
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest remote
15+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest remote apidocs
1616

1717
help:
1818
@echo "Please use \`make <target>' where <target> is one of"
@@ -41,9 +41,10 @@ html:
4141
@echo
4242
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
4343

44-
apidocs: html
45-
mkdir -p $(BUILDDIR)/html/apidocs
46-
pdoc -o $(BUILDDIR)/html/apidocs --no-show-source --logo https://www.red-dove.com/assets/img/rdclogo.gif ../distlib
44+
apidocs:
45+
# mkdir -p $(BUILDDIR)/html/apidocs
46+
# pdoc -o $(BUILDDIR)/html/apidocs --no-show-source --logo https://www.red-dove.com/assets/img/rdclogo.gif ../distlib
47+
docfrag --venv local_tools --libs .. -f apitip distlib distlib.database distlib.index distlib.locators distlib.manifest distlib.markers distlib.metadata distlib.resources distlib.scripts distlib.util distlib.version distlib.wheel > hover.json
4748

4849
remote:
4950
rsync -avz $(BUILDDIR)/html/* vopal:~/apps/rdc_docs/distlib

docs/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,12 @@
101101
'sizzle': {'globaltoc_depth': 5},
102102
}
103103

104+
if html_theme == 'sizzle' and os.path.isfile('hover.json'):
105+
import json
106+
107+
with open('hover.json', encoding='utf-8') as f:
108+
THEME_OPTIONS['sizzle']['custom_data'] = {'hovers': json.load(f) }
109+
104110
# Theme options are theme-specific and customize the look and feel of a theme
105111
# further. For a list of options available for each theme, see the
106112
# documentation.

0 commit comments

Comments
 (0)