Commit a54b7796 authored by psi29a's avatar psi29a
Browse files

Revert "Revert "remove breath/doxygen autodoc""

This reverts commit 038d5a55.
parent ee3aba14
Pipeline #26124927 passed with stages
in 33 minutes and 1 second
breathe
parse_cmake
sphinx>=1.7.0
......@@ -11,7 +11,6 @@
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import glob
import os
import sys
......@@ -21,12 +20,6 @@ import sys
project_root = os.path.abspath('../../')
sys.path.insert(0, project_root)
def insensitive_glob(pattern):
def either(c):
return '[%s%s]' % (c.lower(), c.upper()) if c.isalpha() else c
return glob.glob(''.join(map(either, pattern)))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
......@@ -44,40 +37,8 @@ extensions = [
'sphinx.ext.autosectionlabel',
]
#autosectionlabel_prefix_document = True
try:
import breathe
extensions.append('breathe')
except ImportError:
print("WARNING: Unable to import breathe, code documentation won't be generated.")
# Where breathe can find the source files
openmw_path = os.path.join(project_root, "apps", "openmw")
openmw_sub_dirs = os.walk(openmw_path).next()[1]
openmw_headers = insensitive_glob(os.path.join(openmw_path, "*.hpp"))
for dir in openmw_sub_dirs:
openmw_headers += insensitive_glob(os.path.join(openmw_path, dir, "*.hpp"))
# massage the headers to get the relative path needed
openmw_headers = [os.path.relpath(x, openmw_path) for x in openmw_headers]
opencs_path = os.path.join(project_root, "apps", "opencs")
opencs_sub_dirs = os.walk(opencs_path).next()[1]
opencs_headers = insensitive_glob(os.path.join(opencs_path, "*.hpp"))
opencs_sub_sub_dirs = []
for dir in opencs_sub_dirs:
opencs_headers += insensitive_glob(os.path.join(opencs_path, dir, "*.hpp"))
opencs_sub_sub_dirs += os.walk(os.path.join(opencs_path, dir)).next()[1]
for sub_dir in opencs_sub_sub_dirs:
opencs_headers += insensitive_glob(os.path.join(opencs_path, dir, sub_dir, "*.hpp"))
opencs_headers = [os.path.relpath(x, opencs_path) for x in opencs_headers]
breathe_projects_source = {
"openmw": (openmw_path, openmw_headers),
"opencs": (opencs_path, opencs_headers),
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
......@@ -92,7 +53,7 @@ master_doc = 'index'
# General information about the project.
project = u'OpenMW'
copyright = u'2016, OpenMW Team'
copyright = u'2017, OpenMW Team'
# The version info for the project you're documenting, acts as replacement for
......
......@@ -3,8 +3,7 @@ Welcome to OpenMW's Documentation!
.. toctree::
:caption: Table of Contents
:maxdepth: 2
:maxdepth: 3
manuals/index
reference/index
source/index
Project Source Documentation
============================
.. toctree::
:caption: Table of Contents
:maxdepth: 2
openmw/index
opencs/index
OpenMW-CS Source Documentation
##############################
.. toctree::
:maxdepth: 2
model/index
view/index
.. autodoxygenfile:: editor.hpp
:project: opencs
\ No newline at end of file
./opencs/model
##############
doc
---
.. autodoxygenfile:: model/doc/blacklist.hpp
:project: opencs
.. autodoxygenfile:: model/doc/document.hpp
:project: opencs
.. autodoxygenfile:: model/doc/documentmanager.hpp
:project: opencs
.. autodoxygenfile:: model/doc/loader.hpp
:project: opencs
.. autodoxygenfile:: model/doc/messages.hpp
:project: opencs
.. autodoxygenfile:: model/doc/operationholder.hpp
:project: opencs
.. autodoxygenfile:: model/doc/operation.hpp
:project: opencs
.. autodoxygenfile:: model/doc/runner.hpp
:project: opencs
.. autodoxygenfile:: model/doc/saving.hpp
:project: opencs
.. autodoxygenfile:: model/doc/savingstages.hpp
:project: opencs
.. autodoxygenfile:: model/doc/savingstate.hpp
:project: opencs
.. autodoxygenfile:: model/doc/stage.hpp
:project: opencs
.. autodoxygenfile:: model/doc/state.hpp
:project: opencs
filter
------
.. autodoxygenfile:: model/filter/andnode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/booleannode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/leafnode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/narynode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/node.hpp
:project: opencs
.. autodoxygenfile:: model/filter/notnode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/ornode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/parser.hpp
:project: opencs
.. autodoxygenfile:: model/filter/textnode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/unarynode.hpp
:project: opencs
.. autodoxygenfile:: model/filter/valuenode.hpp
:project: opencs
prefs
-----
.. autodoxygenfile:: model/prefs/boolsetting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/category.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/coloursetting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/doublesetting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/enumsetting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/intsetting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/modifiersetting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/setting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/shortcuteventhandler.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/shortcut.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/shortcutmanager.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/shortcutsetting.hpp
:project: opencs
.. autodoxygenfile:: model/prefs/state.hpp
:project: opencs
tools
-----
.. autodoxygenfile:: model/tools/birthsigncheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/bodypartcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/classcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/factioncheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/gmstcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/journalcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/magiceffectcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/mandatoryid.hpp
:project: opencs
.. autodoxygenfile:: model/tools/mergeoperation.hpp
:project: opencs
.. autodoxygenfile:: model/tools/mergestages.hpp
:project: opencs
.. autodoxygenfile:: model/tools/mergestate.hpp
:project: opencs
.. autodoxygenfile:: model/tools/pathgridcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/racecheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/referenceablecheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/referencecheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/regioncheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/reportmodel.hpp
:project: opencs
.. autodoxygenfile:: model/tools/scriptcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/search.hpp
:project: opencs
.. autodoxygenfile:: model/tools/searchoperation.hpp
:project: opencs
.. autodoxygenfile:: model/tools/searchstage.hpp
:project: opencs
.. autodoxygenfile:: model/tools/skillcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/soundcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/soundgencheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/spellcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/startscriptcheck.hpp
:project: opencs
.. autodoxygenfile:: model/tools/tools.hpp
:project: opencs
.. autodoxygenfile:: model/tools/topicinfocheck.hpp
:project: opencs
world
-----
.. autodoxygenfile:: model/world/cellcoordinates.hpp
:project: opencs
.. autodoxygenfile:: model/world/cell.hpp
:project: opencs
.. autodoxygenfile:: model/world/cellselection.hpp
:project: opencs
.. autodoxygenfile:: model/world/collectionbase.hpp
:project: opencs
.. autodoxygenfile:: model/world/collection.hpp
:project: opencs
.. autodoxygenfile:: model/world/columnbase.hpp
:project: opencs
.. autodoxygenfile:: model/world/columnimp.hpp
:project: opencs
.. autodoxygenfile:: model/world/columns.hpp
:project: opencs
.. autodoxygenfile:: model/world/commanddispatcher.hpp
:project: opencs
.. autodoxygenfile:: model/world/commandmacro.hpp
:project: opencs
.. autodoxygenfile:: model/world/commands.hpp
:project: opencs
.. autodoxygenfile:: model/world/data.hpp
:project: opencs
.. autodoxygenfile:: model/world/defaultgmsts.hpp
:project: opencs
.. autodoxygenfile:: model/world/idcollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/idcompletionmanager.hpp
:project: opencs
.. autodoxygenfile:: model/world/idtablebase.hpp
:project: opencs
.. autodoxygenfile:: model/world/idtable.hpp
:project: opencs
.. autodoxygenfile:: model/world/idtableproxymodel.hpp
:project: opencs
.. autodoxygenfile:: model/world/idtree.hpp
:project: opencs
.. autodoxygenfile:: model/world/infocollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/info.hpp
:project: opencs
.. autodoxygenfile:: model/world/infoselectwrapper.hpp
:project: opencs
.. autodoxygenfile:: model/world/infotableproxymodel.hpp
:project: opencs
.. autodoxygenfile:: model/world/land.hpp
:project: opencs
.. autodoxygenfile:: model/world/landtexture.hpp
:project: opencs
.. autodoxygenfile:: model/world/metadata.hpp
:project: opencs
.. autodoxygenfile:: model/world/nestedcoladapterimp.hpp
:project: opencs
.. autodoxygenfile:: model/world/nestedcollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/nestedcolumnadapter.hpp
:project: opencs
.. autodoxygenfile:: model/world/nestedidcollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/nestedinfocollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/nestedtableproxymodel.hpp
:project: opencs
.. autodoxygenfile:: model/world/nestedtablewrapper.hpp
:project: opencs
.. autodoxygenfile:: model/world/pathgrid.hpp
:project: opencs
.. autodoxygenfile:: model/world/record.hpp
:project: opencs
.. autodoxygenfile:: model/world/refcollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/ref.hpp
:project: opencs
.. autodoxygenfile:: model/world/refidadapter.hpp
:project: opencs
.. autodoxygenfile:: model/world/refidadapterimp.hpp
:project: opencs
.. autodoxygenfile:: model/world/refidcollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/refiddata.hpp
:project: opencs
.. autodoxygenfile:: model/world/regionmap.hpp
:project: opencs
.. autodoxygenfile:: model/world/resources.hpp
:project: opencs
.. autodoxygenfile:: model/world/resourcesmanager.hpp
:project: opencs
.. autodoxygenfile:: model/world/resourcetable.hpp
:project: opencs
.. autodoxygenfile:: model/world/scope.hpp
:project: opencs
.. autodoxygenfile:: model/world/scriptcontext.hpp
:project: opencs
.. autodoxygenfile:: model/world/subcellcollection.hpp
:project: opencs
.. autodoxygenfile:: model/world/tablemimedata.hpp
:project: opencs
.. autodoxygenfile:: model/world/universalid.hpp
:project: opencs
./opencs/view
#############
doc
---
.. autodoxygenfile:: view/doc/adjusterwidget.hpp
:project: opencs
.. autodoxygenfile:: view/doc/filedialog.hpp
:project: opencs
.. autodoxygenfile:: view/doc/filewidget.hpp
:project: opencs
.. autodoxygenfile:: view/doc/globaldebugprofilemenu.hpp
:project: opencs
.. autodoxygenfile:: view/doc/loader.hpp
:project: opencs
.. autodoxygenfile:: view/doc/newgame.hpp
:project: opencs
.. autodoxygenfile:: view/doc/operation.hpp
:project: opencs
.. autodoxygenfile:: view/doc/operations.hpp
:project: opencs
.. autodoxygenfile:: view/doc/runlogsubview.hpp
:project: opencs
.. autodoxygenfile:: view/doc/sizehint.hpp
:project: opencs
.. autodoxygenfile:: view/doc/startup.hpp
:project: opencs
.. autodoxygenfile:: view/doc/subviewfactory.hpp
:project: opencs
.. autodoxygenfile:: view/doc/subviewfactoryimp.hpp
:project: opencs
.. autodoxygenfile:: view/doc/subview.hpp
:project: opencs
.. autodoxygenfile:: view/doc/view.hpp
:project: opencs
.. autodoxygenfile:: view/doc/viewmanager.hpp
:project: opencs
filter
------
.. autodoxygenfile:: view/filter/editwidget.hpp
:project: opencs
.. autodoxygenfile:: view/filter/filterbox.hpp
:project: opencs
.. autodoxygenfile:: view/filter/recordfilterbox.hpp
:project: opencs
prefs
-----
.. autodoxygenfile:: view/prefs/dialogue.hpp
:project: opencs
.. autodoxygenfile:: view/prefs/keybindingpage.hpp
:project: opencs
.. autodoxygenfile:: view/prefs/pagebase.hpp
:project: opencs
.. autodoxygenfile:: view/prefs/page.hpp
:project: opencs
render
------
.. autodoxygenfile:: view/render/cameracontroller.hpp
:project: opencs
.. autodoxygenfile:: view/render/cellarrow.hpp
:project: opencs
.. autodoxygenfile:: view/render/cellborder.hpp
:project: opencs
.. autodoxygenfile:: view/render/cell.hpp
:project: opencs
.. autodoxygenfile:: view/render/cellmarker.hpp
:project: opencs
.. autodoxygenfile:: view/render/cellwater.hpp
:project: opencs
.. autodoxygenfile:: view/render/editmode.hpp
:project: opencs
.. autodoxygenfile:: view/render/instancemode.hpp
:project: opencs
.. autodoxygenfile:: view/render/instancemovemode.hpp
:project: opencs
.. autodoxygenfile:: view/render/instanceselectionmode.hpp
:project: opencs
.. autodoxygenfile:: view/render/lightingbright.hpp
:project: opencs
.. autodoxygenfile:: view/render/lightingday.hpp
:project: opencs
.. autodoxygenfile:: view/render/lighting.hpp
:project: opencs
.. autodoxygenfile:: view/render/lightingnight.hpp
:project: opencs
.. autodoxygenfile:: view/render/mask.hpp
:project: opencs
.. autodoxygenfile:: view/render/object.hpp
:project: opencs
.. autodoxygenfile:: view/render/orbitcameramode.hpp
:project: opencs
.. autodoxygenfile:: view/render/pagedworldspacewidget.hpp
:project: opencs
.. autodoxygenfile:: view/render/pathgrid.hpp
:project: opencs
.. autodoxygenfile:: view/render/pathgridmode.hpp
:project: opencs
.. autodoxygenfile:: view/render/pathgridselectionmode.hpp
:project: opencs
.. autodoxygenfile:: view/render/previewwidget.hpp
:project: opencs
.. autodoxygenfile:: view/render/scenewidget.hpp
:project: opencs
.. autodoxygenfile:: view/render/selectionmode.hpp
:project: opencs
.. autodoxygenfile:: view/render/tagbase.hpp
:project: opencs
.. autodoxygenfile:: view/render/terrainstorage.hpp
:project: opencs
.. autodoxygenfile:: view/render/unpagedworldspacewidget.hpp
:project: opencs
.. autodoxygenfile:: view/render/worldspacewidget.hpp
:project: opencs
tools
-----
.. autodoxygenfile:: view/tools/merge.hpp
:project: opencs