From 0e6dfe3e22fa6a9214655ee8b91e0218789805cf Mon Sep 17 00:00:00 2001 From: yorikvanhavre Date: Fri, 2 Dec 2011 15:45:30 +0000 Subject: [PATCH] + added sphinx documentation structure git-svn-id: https://free-cad.svn.sourceforge.net/svnroot/free-cad/trunk@5207 e8eeb9e2-ec13-0410-a4a9-efa5cf37419d --- src/Doc/sphinx/Arch.rst | 37 +++ src/Doc/sphinx/Draft.rst | 10 + src/Doc/sphinx/Drawing.rst | 8 + src/Doc/sphinx/FreeCAD.rst | 17 + src/Doc/sphinx/FreeCADGui.rst | 9 + src/Doc/sphinx/Makefile | 130 ++++++++ src/Doc/sphinx/Mesh.rst | 11 + src/Doc/sphinx/Part.rst | 11 + src/Doc/sphinx/PartDesign.rst | 8 + src/Doc/sphinx/RayTracing.rst | 8 + src/Doc/sphinx/Sketch.rst | 8 + src/Doc/sphinx/_static/freecad.css | 497 +++++++++++++++++++++++++++++ src/Doc/sphinx/conf.py | 222 +++++++++++++ src/Doc/sphinx/index.rst | 27 ++ src/Doc/sphinx/make.bat | 170 ++++++++++ 15 files changed, 1173 insertions(+) create mode 100644 src/Doc/sphinx/Arch.rst create mode 100644 src/Doc/sphinx/Draft.rst create mode 100644 src/Doc/sphinx/Drawing.rst create mode 100644 src/Doc/sphinx/FreeCAD.rst create mode 100644 src/Doc/sphinx/FreeCADGui.rst create mode 100644 src/Doc/sphinx/Makefile create mode 100644 src/Doc/sphinx/Mesh.rst create mode 100644 src/Doc/sphinx/Part.rst create mode 100644 src/Doc/sphinx/PartDesign.rst create mode 100644 src/Doc/sphinx/RayTracing.rst create mode 100644 src/Doc/sphinx/Sketch.rst create mode 100644 src/Doc/sphinx/_static/freecad.css create mode 100644 src/Doc/sphinx/conf.py create mode 100644 src/Doc/sphinx/index.rst create mode 100644 src/Doc/sphinx/make.bat diff --git a/src/Doc/sphinx/Arch.rst b/src/Doc/sphinx/Arch.rst new file mode 100644 index 0000000000..c126eb3271 --- /dev/null +++ b/src/Doc/sphinx/Arch.rst @@ -0,0 +1,37 @@ +The Arch module +=============== + +The Arch module is a metamodule that imports useful methods from several of the Arch submodules. + +.. toctree:: + :maxdepth: 4 + +.. automodule:: Arch + :members: + +.. automodule:: Wall + :members: + +.. automodule:: Cell + :members: + +.. automodule:: Floor + :members: + +.. automodule:: Site + :members: + +.. automodule:: Structure + :members: + +.. automodule:: Window + :members: + +.. automodule:: SectionPlane + :members: + +.. automodule:: Building + :members: + +.. automodule:: Commands + :members: diff --git a/src/Doc/sphinx/Draft.rst b/src/Doc/sphinx/Draft.rst new file mode 100644 index 0000000000..63e5776329 --- /dev/null +++ b/src/Doc/sphinx/Draft.rst @@ -0,0 +1,10 @@ +The Draft module +================ + +The Draft module offer several convenient functions to work with simple objects. + +.. toctree:: + :maxdepth: 4 + +.. automodule:: Draft + :members: diff --git a/src/Doc/sphinx/Drawing.rst b/src/Doc/sphinx/Drawing.rst new file mode 100644 index 0000000000..f3a690f551 --- /dev/null +++ b/src/Doc/sphinx/Drawing.rst @@ -0,0 +1,8 @@ +The Drawing module +================== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: Drawing + :members: diff --git a/src/Doc/sphinx/FreeCAD.rst b/src/Doc/sphinx/FreeCAD.rst new file mode 100644 index 0000000000..a2642f879a --- /dev/null +++ b/src/Doc/sphinx/FreeCAD.rst @@ -0,0 +1,17 @@ +The FreeCAD module +================== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: FreeCAD + :members: + + .. autoclass:: Vector + :members: + + .. autoclass:: Matrix + :members: + + .. autoclass:: Placement + :members: diff --git a/src/Doc/sphinx/FreeCADGui.rst b/src/Doc/sphinx/FreeCADGui.rst new file mode 100644 index 0000000000..2a64fce115 --- /dev/null +++ b/src/Doc/sphinx/FreeCADGui.rst @@ -0,0 +1,9 @@ +The FreeCADGui module +===================== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: FreeCADGui + :members: + diff --git a/src/Doc/sphinx/Makefile b/src/Doc/sphinx/Makefile new file mode 100644 index 0000000000..750032ae50 --- /dev/null +++ b/src/Doc/sphinx/Makefile @@ -0,0 +1,130 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + -rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/FreeCAD.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/FreeCAD.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/FreeCAD" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/FreeCAD" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." diff --git a/src/Doc/sphinx/Mesh.rst b/src/Doc/sphinx/Mesh.rst new file mode 100644 index 0000000000..cbf7058692 --- /dev/null +++ b/src/Doc/sphinx/Mesh.rst @@ -0,0 +1,11 @@ +The Mesh module +=============== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: Mesh + :members: + +.. automodule:: MeshGui + :members: diff --git a/src/Doc/sphinx/Part.rst b/src/Doc/sphinx/Part.rst new file mode 100644 index 0000000000..320afe9af3 --- /dev/null +++ b/src/Doc/sphinx/Part.rst @@ -0,0 +1,11 @@ +The Part module +=============== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: Part + :members: + +.. automodule:: PartGui + :members: diff --git a/src/Doc/sphinx/PartDesign.rst b/src/Doc/sphinx/PartDesign.rst new file mode 100644 index 0000000000..5710d0d4c7 --- /dev/null +++ b/src/Doc/sphinx/PartDesign.rst @@ -0,0 +1,8 @@ +The PartDesign module +===================== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: PartDesign + :members: diff --git a/src/Doc/sphinx/RayTracing.rst b/src/Doc/sphinx/RayTracing.rst new file mode 100644 index 0000000000..59239aeb9b --- /dev/null +++ b/src/Doc/sphinx/RayTracing.rst @@ -0,0 +1,8 @@ +The RayTracing module +===================== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: Raytracing + :members: diff --git a/src/Doc/sphinx/Sketch.rst b/src/Doc/sphinx/Sketch.rst new file mode 100644 index 0000000000..f08062204d --- /dev/null +++ b/src/Doc/sphinx/Sketch.rst @@ -0,0 +1,8 @@ +The Sketcher module +=================== + +.. toctree:: + :maxdepth: 4 + +.. automodule:: Sketcher + :members: diff --git a/src/Doc/sphinx/_static/freecad.css b/src/Doc/sphinx/_static/freecad.css new file mode 100644 index 0000000000..c53466666d --- /dev/null +++ b/src/Doc/sphinx/_static/freecad.css @@ -0,0 +1,497 @@ +/* FreeCAD CSS template by Yorik */ + +/* general settings ******************************* */ + +a, #bodyContent a.external { + color: #0092E8; + } + +a.new, .new a, #p-cactions .new a, #p-personal a.new { + color: #FF1F00; + } + +h1 { + background: #0092E8; + border: none; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + color: white; + font-weight: bold; + padding: 5px; + margin: 10px 0; + } + +h2 { + font-weight: normal; + } + +h4 { + font-size: 90%; + font-weight: bold; + } + +pre { + border: 1px solid #AAAAAA; + background: #EEEEEE; + } + +.docnav { + background: #D3D7D9; + padding: 3px; + border: none; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + margin-top: 15px; + } + +.languages { + font-size: 9px; + padding:2px 5px; + color: #666666; + border: none; + border-top: 1px solid #666666; + margin-top: 10px; + } + +#bodyContent a[href^="https://"], .link-https { + padding: 0 16px 0 0; + } + +/* homepage ******************************* */ + +body[class*='page-Main_Page'] { + text-align: justify; + } + +body[class*='page-Main_Page'] h1 { + background: none; + margin-bottom: 0; + border-bottom: 1px solid #638C9C; + padding-bottom: 15px; + } + +body[class*='page-Main_Page'] h2 { + color: #FFF; + border-bottom: none; + margin-bottom: 20px !important; + } + +body[class*='page-Main_Page'] h3 { + color: white; + font-size: 105%; + font-weight: bold; + } + +body[class*='page-Main_Page'] h1 .mw-headline { + font-size: 2em; + letter-spacing: 20px; + } + +body[class*='page-Main_Page'] #bodyContent a:visited { + color: #0092E8; + } + +body[class*='page-Main_Page'] h1.firstHeading { + display:none; + } + +body[class*='page-Main_Page'] #content { + background: transparent; + color: white; + } + +body[class*='page-Main_Page'] #content ul { + list-style-type: none; + list-style-image: none; + margin: 0; + } + +/* homepage toolboxes & menus ******************************** */ + +.main-toolbox { + float: right; + width: 300px; + margin-left: 25px; + } + +.main-menu { + margin-bottom: 40px; + } + +.main-menu a { + color: #FFF !important; + } + +.main-content { + display: table; + } + +#feedholder, #mantisholder, .sidebox, #fbholder { + max-width: 300px; + border: 1px solid #AAAAAA; + background-color:#EEEEEE; + padding:1.2em; + color: black; + margin-top: 10px; + font-size: 0.85em; + text-align: left; + } + +#feedholder .title, #mantisholder .title, .sidebox .title { + font-weight: bold; + font-size: 1.2em; + } + +#feedholder .title a, #mantisholder .title a, .sidebox .title a { + float: right; + } + +#fbholder { + padding: 0; + } + +.downloadbox { + background: white url(/userapps/mediawiki/yorikvanhavre/nfs/user/y/yo/yorikvanhavre/6/65/Download.jpg) top left no-repeat; + padding: 10px 10px 10px 80px; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + text-align: left; + margin-bottom: 15px; + color: black; + font-weight: bold; + } + +#bodyContent .downloadbox li a.external { + display: box; + color: #005295; + padding: 3px 13px 3px 3px; + } + +/* wikibars ******************************** */ + +#p-cactions { + padding: 0 60px; + /* top: 3px; */ + width: auto; + z-index: 2; + } + +#p-cactions li, #p-cactions li a, #p-personal li a { + color: #0092E8; + background: none; + padding: 1px 5px !important; + margin: 0 !important; + } + +#globalWrapper { + background: #171a2a url(/userapps/mediawiki/yorikvanhavre/nfs/user/y/yo/yorikvanhavre/1/1f/Background.jpg) top left no-repeat !important; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + width: auto !important; + margin:5px; + } + +.portlet { + width: auto; + padding-right: 5px; + } + +.pBody { + background: transparent; + border: none; + padding: 0 } + +.pBody a { + color: white; + padding: 1px 5px !important; + } + +.portlet ul { + margin: 0; + } + +.portlet li { + margin-left: 5px; + list-style-position: inside; + } + +#column-one { + margin-left: 3px; + padding-top: 160px; + } + +#p-cactions li a:hover, #p-personal li a:hover, #p-cactions li.selected a, #bodyContent .downloadbox li a.external:hover { + color: white; + background: #0092E8; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + text-decoration: none; + } + +/* content ******************************** */ + +#column-content { + margin:0 0 0.6em -12.2em !important; + padding: 5px; + width: 96%; + } + +#content { + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + } + +#content, #p-cactions li { + border: none; + padding: 0.6em 1em 1em; + } + +#footer { + background: none; + border: none; + color: #fff; + } + +/* sidebar ******************************** */ + +.portlet h5 { + color: #638C9C; + text-transform: uppercase; + font-size: 75%; + height: 15px; + display: block; + margin-bottom: 5px; + border-bottom: 1px solid #638C9C; + padding-left: 10px; + } + +#p- h5 { + display: none; + } + +#p-search, #p-Documentation, #p-tb, #p-languages, #p-Meta, #p-Feedback, #p-Manual { + max-width: 180px; + } + +#n-Basic, #n-Advanced, #n-Development, #n-Using-FreeCAD, #n-Python-Scripting { + list-style: none; + font-size: 12px; + text-transform: uppercase; + font-weight: bold; + padding: 3px 0; + } + +#n-Home { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/9/9a/Home.png); + } + +#n-Features { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/5/53/Features16.png); + } + +#n-Screenshots { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/e/ef/Screenshots16.png); + } + +#n-Downloads { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/e/ed/Download16.png); + } + +#n-Getting-Started { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/b/b4/Gettingstarted16.png); + } + +#n-FAQ { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/8/86/Faq16.png); + } + +#n-Forum { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/6/6a/Forum16.png); + } + +#n-Tutorials { + list-style-image: url(/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/4/46/Tutorials.png); + } + +/* Commands Template******************* */ + +.ct { + padding: 5px; + background: #eeeeee; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + margin: 5px 0 15px 8px; + } + +.ctEven { + background-color:#F9F9F9; + border:1px solid #AAAAAA; + padding: 2px; + } + +.ctToc .toc { + width: 100%; + } + +.left { + text-align: left; + } + +/* API ******************************** */ + +.api { + margin-left: 30px; + } + +.api .function { + padding: 3px; + background: #dddddd; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; + } + +.api .description { + padding-left: 30px; + } + +/* Screenshots ************************ */ + +.screenthumbs { + padding: 5px; + background: #eeeeee; + -moz-border-radius: 3px; + -webkit-border-radius: 3px; + width: 800px; + } + +/* Translations *********************** */ + +body[class*='_it'] h1.firstHeading, body[class*='_fr'] h1.firstHeading { + display:none; + } + +h1 .editsection a:link { + color: white; + font-weight: normal; + } + +/* Charts *********************** */ + +.orgchart { + margin: 10px; + background: #EEEEEE; + text-align: center; + width: 800px; + padding: 4px; + border-radius: 5px; + border-spacing: 0; + } + +.orgheader { + background: #9FBDE0; + } + +.orgchart td { + padding: 0; + } +/* Printing ************************ */ + +@media print { + +body { + font: small sans-serif; + text-align: left; + } + +a{ + color: blue; + } + +h1 { + background: none; + border: none; + color: black; + font-weight: bold; + padding: 5px; + margin-top: 10px; + } + +#globalWrapper { + backgound: none; + } + +#column-content { + margin:0 !important; + padding: 5px; + width: auto; + } + +.docnav, .languages, #sf_header { + display: none; + } + +.toc { + border: none; + } + +.thumbcaption { + text-align: left; + } + +} + +/* sphinx-specific *****************************/ + +body { + background: #171a2a url(http://www.sourceforge.net/userapps/mediawiki/yorikvanhavre/nfs/user/y/yo/yorikvanhavre/1/1f/Background.jpg) top left no-repeat !important; + font-family: sans-serif; + color: #ffffff; +} + +.document { + background: url(http://sourceforge.net/apps/mediawiki/free-cad/nfs/project/f/fr/free-cad/7/70/MediaWikiSidebarLogo.png) top left no-repeat; +} + +.related h3 { + display: none; +} + +.related ul { + float: right; +} + +.related ul li { + display: inline; + font-size: 0.8em; +} + +.documentwrapper { + color: #000000; + background: none repeat scroll 0 0 white; + border-radius: 5px; + padding: 0.6em; + position: relative; + z-index: 2; + float: right; + width: 75% +} + +.sphinxsidebar { + font-size: 0.8em; + width: 220px; + padding-top: 100px; +} + +.clearer { + clear: both; +} + +a.headerlink { + display: none; +} + +.footer { + clear: both; + font-size: 0.7em; + text-align: center; +} diff --git a/src/Doc/sphinx/conf.py b/src/Doc/sphinx/conf.py new file mode 100644 index 0000000000..1cbc723e47 --- /dev/null +++ b/src/Doc/sphinx/conf.py @@ -0,0 +1,222 @@ +# -*- coding: utf-8 -*- +# +# FreeCAD documentation build configuration file, created by +# sphinx-quickstart on Wed Nov 30 10:49:09 2011. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +sys.path.append(os.path.abspath('/home/yorik/Apps/FreeCAD/lib/')) +import FreeCAD, FreeCADGui +FreeCADGui.showMainWindow() # this is needed for complete import of GUI modules + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'FreeCAD' +copyright = u'2011, Jürgen Riegel, Werner Mayer, Yorik van Havre' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.12' +# The full version, including alpha/beta/rc tags. +release = '0.12' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +html_style = 'freecad.css' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'FreeCADdoc' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'FreeCAD.tex', u'FreeCAD Documentation', + u'Jürgen Riegel, Werner Mayer,Yorik van Havre', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'freecad', u'FreeCAD Documentation', + [u'Jürgen Riegel, Werner Mayer, Yorik van Havre'], 1) +] diff --git a/src/Doc/sphinx/index.rst b/src/Doc/sphinx/index.rst new file mode 100644 index 0000000000..715da57144 --- /dev/null +++ b/src/Doc/sphinx/index.rst @@ -0,0 +1,27 @@ +.. FreeCAD documentation master file, created by + sphinx-quickstart on Wed Nov 30 10:49:09 2011. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +FreeCAD python API documentation +================================ + +This is the complete python API reference of the FreeCAD appication + +.. toctree:: + :maxdepth: 4 + + FreeCAD.rst + FreeCADGui.rst + Mesh.rst + Part.rst + Sketch.rst + PartDesign.rst + Draft.rst + Arch.rst + Drawing.rst + RayTracing.rst + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/Doc/sphinx/make.bat b/src/Doc/sphinx/make.bat new file mode 100644 index 0000000000..f7a8b717cb --- /dev/null +++ b/src/Doc/sphinx/make.bat @@ -0,0 +1,170 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. changes to make an overview over all changed/added/deprecated items + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\FreeCAD.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\FreeCAD.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +:end