Skip to content

Commit 286df2c

Browse files
dhellmanndhellmann
committed
move es and ja versions of docs to their own repositories
--HG-- rename : docs/en/command_ref.rst => docs/source/command_ref.rst rename : docs/sphinx/conf.py => docs/source/conf.py rename : docs/en/developers.rst => docs/source/developers.rst rename : docs/en/extensions.rst => docs/source/extensions.rst rename : docs/en/history.rst => docs/source/history.rst rename : docs/en/hooks.rst => docs/source/hooks.rst rename : docs/en/index.rst => docs/source/index.rst rename : docs/en/install.rst => docs/source/install.rst rename : docs/en/plugins.rst => docs/source/plugins.rst rename : docs/en/projects.rst => docs/source/projects.rst rename : docs/en/scripts.rst => docs/source/scripts.rst rename : docs/en/tips.rst => docs/source/tips.rst
1 parent 7f0e0e5 commit 286df2c

35 files changed

+137
-5484
lines changed

‎Makefile‎

Lines changed: 1 addition & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,6 @@ help:
77
@echo "develop - install development version"
88
@echo "test - run the test suite"
99
@echo "test-quick - run the test suite for bash and one version of Python ($(PYTHON26))"
10-
@echo "website - generate web version of the docs"
11-
@echo "installwebsite - copy web version of HTML docs up to server"
1210

1311
.PHONY: sdist
1412
sdist: html
@@ -20,28 +18,12 @@ sdist: html
2018
# Documentation
2119
.PHONY: html
2220
html:
23-
(cd docs && $(MAKE) html LANGUAGE="en")
24-
(cd docs && $(MAKE) html LANGUAGE="es")
25-
(cd docs && $(MAKE) html LANGUAGE="ja")
21+
(cd docs && $(MAKE) html)
2622

2723
.PHONY: docclean
2824
docclean:
2925
rm -rf docs/build docs/html
3026

31-
# Website copy of documentation
32-
.PHONY: website
33-
website:
34-
[ ~/Devel/doughellmann/doughellmann/templates/base.html -nt docs/sphinx/web/templates/base.html ] && (echo "Updating base.html" ; cp ~/Devel/doughellmann/doughellmann/templates/base.html docs/sphinx/web/templates/base.html) || exit 0
35-
rm -rf docs/website
36-
(cd docs && $(MAKE) html BUILDDIR="website/en" LANGUAGE="en")
37-
(cd docs && $(MAKE) html BUILDDIR="website/es" LANGUAGE="es")
38-
(cd docs && $(MAKE) html BUILDDIR="website/ja" LANGUAGE="ja")
39-
40-
installwebsite: website
41-
(cd docs/website/en && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/)
42-
(cd docs/website/es && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/es/)
43-
(cd docs/website/ja && rsync --rsh=ssh --archive --delete --verbose . www.doughellmann.com:/var/www/doughellmann/DocumentRoot/docs/virtualenvwrapper/ja/)
44-
4527
# Register the new version on pypi
4628
.PHONY: register
4729
register:

‎docs/Makefile‎

Lines changed: 134 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,92 +1,153 @@
11
# Makefile for Sphinx documentation
22
#
33

4-
# If doc language is English you don't need to set this variable
5-
LANGUAGE = en
6-
74
# You can set these variables from the command line.
8-
SPHINXOPTS = -c sphinx
5+
SPHINXOPTS =
96
SPHINXBUILD = sphinx-build
107
PAPER =
11-
BUILDDIR = html/$(LANGUAGE)
8+
BUILDDIR = build
129

1310
# Internal variables.
1411
PAPEROPT_a4 = -D latex_paper_size=a4
1512
PAPEROPT_letter = -D latex_paper_size=letter
16-
ALLSPHINXOPTS = -d build/$(LANGUAGE)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) $(LANGUAGE)
13+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
14+
# the i18n builder cannot share the environment and doctrees with the others
15+
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
1716

18-
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
1918

2019
help:
2120
@echo "Please use \`make <target>' where <target> is one of"
22-
@echo " html to make standalone HTML files"
23-
@echo " dirhtml to make HTML files named index.html in directories"
24-
@echo " pickle to make pickle files"
25-
@echo " json to make JSON files"
26-
@echo " htmlhelp to make HTML files and a HTML help project"
27-
@echo " qthelp to make HTML files and a qthelp project"
28-
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29-
@echo " changes to make an overview of all changed/added/deprecated items"
30-
@echo " linkcheck to check all external links for integrity"
31-
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
21+
@echo " html to make standalone HTML files"
22+
@echo " dirhtml to make HTML files named index.html in directories"
23+
@echo " singlehtml to make a single large HTML file"
24+
@echo " pickle to make pickle files"
25+
@echo " json to make JSON files"
26+
@echo " htmlhelp to make HTML files and a HTML help project"
27+
@echo " qthelp to make HTML files and a qthelp project"
28+
@echo " devhelp to make HTML files and a Devhelp project"
29+
@echo " epub to make an epub"
30+
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31+
@echo " latexpdf to make LaTeX files and run them through pdflatex"
32+
@echo " text to make text files"
33+
@echo " man to make manual pages"
34+
@echo " texinfo to make Texinfo files"
35+
@echo " info to make Texinfo files and run them through makeinfo"
36+
@echo " gettext to make PO message catalogs"
37+
@echo " changes to make an overview of all changed/added/deprecated items"
38+
@echo " linkcheck to check all external links for integrity"
39+
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
3240

3341
clean:
3442
-rm -rf $(BUILDDIR)/*
3543

3644
html:
37-
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)
38-
@echo
39-
@echo "Build finished. The HTML pages are in $(BUILDDIR)."
40-
41-
# dirhtml:
42-
# $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
43-
# @echo
44-
# @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
45-
46-
# pickle:
47-
# $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
48-
# @echo
49-
# @echo "Build finished; now you can process the pickle files."
50-
51-
# json:
52-
# $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
53-
# @echo
54-
# @echo "Build finished; now you can process the JSON files."
55-
56-
# htmlhelp:
57-
# $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
58-
# @echo
59-
# @echo "Build finished; now you can run HTML Help Workshop with the" \
60-
# ".hhp project file in $(BUILDDIR)/htmlhelp."
61-
62-
# qthelp:
63-
# $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
64-
# @echo
65-
# @echo "Build finished; now you can run "qcollectiongenerator" with the" \
66-
# ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
67-
# @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/virtualenvwrapper.qhcp"
68-
# @echo "To view the help file:"
69-
# @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/virtualenvwrapper.qhc"
70-
71-
# latex:
72-
# $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
73-
# @echo
74-
# @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
75-
# @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
76-
# "run these through (pdf)latex."
77-
78-
# changes:
79-
# $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
80-
# @echo
81-
# @echo "The overview file is in $(BUILDDIR)/changes."
82-
83-
# linkcheck:
84-
# $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
85-
# @echo
86-
# @echo "Link check complete; look for any errors in the above output " \
87-
# "or in $(BUILDDIR)/linkcheck/output.txt."
88-
89-
# doctest:
90-
# $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
91-
# @echo "Testing of doctests in the sources finished, look at the " \
92-
# "results in $(BUILDDIR)/doctest/output.txt."
45+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
46+
@echo
47+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
48+
49+
dirhtml:
50+
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
51+
@echo
52+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
53+
54+
singlehtml:
55+
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
56+
@echo
57+
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
58+
59+
pickle:
60+
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
61+
@echo
62+
@echo "Build finished; now you can process the pickle files."
63+
64+
json:
65+
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
66+
@echo
67+
@echo "Build finished; now you can process the JSON files."
68+
69+
htmlhelp:
70+
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
71+
@echo
72+
@echo "Build finished; now you can run HTML Help Workshop with the" \
73+
".hhp project file in $(BUILDDIR)/htmlhelp."
74+
75+
qthelp:
76+
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
77+
@echo
78+
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
79+
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
80+
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/virtualenvwrapper.qhcp"
81+
@echo "To view the help file:"
82+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/virtualenvwrapper.qhc"
83+
84+
devhelp:
85+
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
86+
@echo
87+
@echo "Build finished."
88+
@echo "To view the help file:"
89+
@echo "# mkdir -p $$HOME/.local/share/devhelp/virtualenvwrapper"
90+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/virtualenvwrapper"
91+
@echo "# devhelp"
92+
93+
epub:
94+
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
95+
@echo
96+
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
97+
98+
latex:
99+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
100+
@echo
101+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
102+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
103+
"(use \`make latexpdf' here to do that automatically)."
104+
105+
latexpdf:
106+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
107+
@echo "Running LaTeX files through pdflatex..."
108+
$(MAKE) -C $(BUILDDIR)/latex all-pdf
109+
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
110+
111+
text:
112+
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
113+
@echo
114+
@echo "Build finished. The text files are in $(BUILDDIR)/text."
115+
116+
man:
117+
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
118+
@echo
119+
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
120+
121+
texinfo:
122+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
123+
@echo
124+
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
125+
@echo "Run \`make' in that directory to run these through makeinfo" \
126+
"(use \`make info' here to do that automatically)."
127+
128+
info:
129+
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
130+
@echo "Running Texinfo files through makeinfo..."
131+
make -C $(BUILDDIR)/texinfo info
132+
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
133+
134+
gettext:
135+
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
136+
@echo
137+
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
138+
139+
changes:
140+
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
141+
@echo
142+
@echo "The overview file is in $(BUILDDIR)/changes."
143+
144+
linkcheck:
145+
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
146+
@echo
147+
@echo "Link check complete; look for any errors in the above output " \
148+
"or in $(BUILDDIR)/linkcheck/output.txt."
149+
150+
doctest:
151+
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
152+
@echo "Testing of doctests in the sources finished, look at the " \
153+
"results in $(BUILDDIR)/doctest/output.txt."

0 commit comments

Comments
 (0)