Skip to content

Commit 2483366

Browse files
ColinDuquesnoyColinDuquesnoy
committed
#7 Add documentation structure (based on pyqode.core, there are still reference to the core package)
1 parent aef693b commit 2483366

15 files changed

Lines changed: 933 additions & 0 deletions

‎doc/Makefile‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
# Makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
PAPER =
8+
BUILDDIR = build
9+
10+
# Internal variables.
11+
PAPEROPT_a4 = -D latex_paper_size=a4
12+
PAPEROPT_letter = -D latex_paper_size=letter
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
16+
17+
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18+
19+
help:
20+
@echo "Please use \`make <target>' where <target> is one of"
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)"
40+
41+
clean:
42+
-rm -rf $(BUILDDIR)/*
43+
44+
html:
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/QCodeEditor.qhcp"
81+
@echo "To view the help file:"
82+
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/QCodeEditor.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/QCodeEditor"
90+
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/QCodeEditor"
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."

‎doc/make.bat‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
@ECHO OFF
2+
3+
REM Command file for Sphinx documentation
4+
5+
if "%SPHINXBUILD%" == "" (
6+
set SPHINXBUILD=sphinx-build
7+
)
8+
set BUILDDIR=build
9+
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
10+
set I18NSPHINXOPTS=%SPHINXOPTS% source
11+
if NOT "%PAPER%" == "" (
12+
set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13+
set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14+
)
15+
16+
if "%1" == "" goto help
17+
18+
if "%1" == "help" (
19+
:help
20+
echo.Please use `make ^<target^>` where ^<target^> is one of
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. text to make text files
32+
echo. man to make manual pages
33+
echo. texinfo to make Texinfo files
34+
echo. gettext to make PO message catalogs
35+
echo. changes to make an overview over all changed/added/deprecated items
36+
echo. linkcheck to check all external links for integrity
37+
echo. doctest to run all doctests embedded in the documentation if enabled
38+
goto end
39+
)
40+
41+
if "%1" == "clean" (
42+
for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
43+
del /q /s %BUILDDIR%\*
44+
goto end
45+
)
46+
47+
if "%1" == "html" (
48+
%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
49+
if errorlevel 1 exit /b 1
50+
echo.
51+
echo.Build finished. The HTML pages are in %BUILDDIR%/html.
52+
goto end
53+
)
54+
55+
if "%1" == "dirhtml" (
56+
%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
57+
if errorlevel 1 exit /b 1
58+
echo.
59+
echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
60+
goto end
61+
)
62+
63+
if "%1" == "singlehtml" (
64+
%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
65+
if errorlevel 1 exit /b 1
66+
echo.
67+
echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
68+
goto end
69+
)
70+
71+
if "%1" == "pickle" (
72+
%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
73+
if errorlevel 1 exit /b 1
74+
echo.
75+
echo.Build finished; now you can process the pickle files.
76+
goto end
77+
)
78+
79+
if "%1" == "json" (
80+
%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
81+
if errorlevel 1 exit /b 1
82+
echo.
83+
echo.Build finished; now you can process the JSON files.
84+
goto end
85+
)
86+
87+
if "%1" == "htmlhelp" (
88+
%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
89+
if errorlevel 1 exit /b 1
90+
echo.
91+
echo.Build finished; now you can run HTML Help Workshop with the ^
92+
.hhp project file in %BUILDDIR%/htmlhelp.
93+
goto end
94+
)
95+
96+
if "%1" == "qthelp" (
97+
%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
98+
if errorlevel 1 exit /b 1
99+
echo.
100+
echo.Build finished; now you can run "qcollectiongenerator" with the ^
101+
.qhcp project file in %BUILDDIR%/qthelp, like this:
102+
echo.^> qcollectiongenerator %BUILDDIR%\qthelp\CodeEditorWidget.qhcp
103+
echo.To view the help file:
104+
echo.^> assistant -collectionFile %BUILDDIR%\qthelp\CodeEditorWidget.ghc
105+
goto end
106+
)
107+
108+
if "%1" == "devhelp" (
109+
%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
110+
if errorlevel 1 exit /b 1
111+
echo.
112+
echo.Build finished.
113+
goto end
114+
)
115+
116+
if "%1" == "epub" (
117+
%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
118+
if errorlevel 1 exit /b 1
119+
echo.
120+
echo.Build finished. The epub file is in %BUILDDIR%/epub.
121+
goto end
122+
)
123+
124+
if "%1" == "latex" (
125+
%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
126+
if errorlevel 1 exit /b 1
127+
echo.
128+
echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
129+
goto end
130+
)
131+
132+
if "%1" == "text" (
133+
%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
134+
if errorlevel 1 exit /b 1
135+
echo.
136+
echo.Build finished. The text files are in %BUILDDIR%/text.
137+
goto end
138+
)
139+
140+
if "%1" == "man" (
141+
%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
142+
if errorlevel 1 exit /b 1
143+
echo.
144+
echo.Build finished. The manual pages are in %BUILDDIR%/man.
145+
goto end
146+
)
147+
148+
if "%1" == "texinfo" (
149+
%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
150+
if errorlevel 1 exit /b 1
151+
echo.
152+
echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
153+
goto end
154+
)
155+
156+
if "%1" == "gettext" (
157+
%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
158+
if errorlevel 1 exit /b 1
159+
echo.
160+
echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
161+
goto end
162+
)
163+
164+
if "%1" == "changes" (
165+
%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
166+
if errorlevel 1 exit /b 1
167+
echo.
168+
echo.The overview file is in %BUILDDIR%/changes.
169+
goto end
170+
)
171+
172+
if "%1" == "linkcheck" (
173+
%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
174+
if errorlevel 1 exit /b 1
175+
echo.
176+
echo.Link check complete; look for any errors in the above output ^
177+
or in %BUILDDIR%/linkcheck/output.txt.
178+
goto end
179+
)
180+
181+
if "%1" == "doctest" (
182+
%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
183+
if errorlevel 1 exit /b 1
184+
echo.
185+
echo.Testing of doctests in the sources finished, look at the ^
186+
results in %BUILDDIR%/doctest/output.txt.
187+
goto end
188+
)
189+
190+
:end

‎doc/make_html.py‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#!/usr/bin/env python
2+
# -*- coding: utf-8 -*-
3+
#
4+
#The MIT License (MIT)
5+
#
6+
#Copyright (c) <2013> <Colin Duquesnoy and others, see AUTHORS.txt>
7+
#
8+
#Permission is hereby granted, free of charge, to any person obtaining a copy
9+
#of this software and associated documentation files (the "Software"), to deal
10+
#in the Software without restriction, including without limitation the rights
11+
#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12+
#copies of the Software, and to permit persons to whom the Software is
13+
#furnished to do so, subject to the following conditions:
14+
#
15+
#The above copyright notice and this permission notice shall be included in
16+
#all copies or substantial portions of the Software.
17+
#
18+
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19+
#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20+
#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21+
#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22+
#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23+
#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24+
#THE SOFTWARE.
25+
#
26+
"""
27+
Call this module to creates the pyQode documentation. (Requires Sphinx to be
28+
installed)
29+
"""
30+
import os
31+
os.system("make html")

‎doc/source/_static/editor_widget.png‎

22.2 KB
Loading

‎doc/source/_static/screenshot.png‎

192 KB
Loading

‎doc/source/api.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
API Reference
2+
======================
3+
4+
The API reference documentation is auto extracted from the source code and only
5+
cover the public API exposed by the **pyqode.core** package.
6+
7+
.. contents:: :local:
8+
9+
QPythonCodeEdit
10+
--------------------
11+
12+
.. autoclass:: pyqode.python.QPythonCodeEdit
13+
:members:
14+
15+
16+
Modes
17+
-----------
18+
19+
20+
Panels
21+
--------------

0 commit comments

Comments
 (0)