mirror/openmw
1
0
Fork 0
mirror of https://github.com/OpenMW/openmw.git synced 2025-10-30 02:56:44 +00:00
Code Issues Releases Wiki Activity

Merge pull request #1352 from psi29a/rtd_fix

Browse source 
remove breath/doxygen autodoc
This commit is contained in:
scrawl 2017-07-28 20:48:23 +00:00 committed by GitHub
commit 9749f8f486
21 changed files with 3 additions and 1622 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CMakeLists.txt
View file

@ -413,7 +413,7 @@ IF(NOT WIN32 AND NOT APPLE)
# Install icon and desktop file # Install icon and desktop file
INSTALL(FILES "${OpenMW_BINARY_DIR}/openmw.desktop" DESTINATION "${DATAROOTDIR}/applications" COMPONENT "openmw") INSTALL(FILES "${OpenMW_BINARY_DIR}/openmw.desktop" DESTINATION "${DATAROOTDIR}/applications" COMPONENT "openmw")
INSTALL(FILES "${OpenMW_SOURCE_DIR}/files/launcher/images/openmw.png" DESTINATION "${ICONDIR}" COMPONENT "openmw") INSTALL(FILES "${OpenMW_SOURCE_DIR}/files/launcher/images/openmw.png" DESTINATION "${ICONDIR}" COMPONENT "openmw")
INSTALL(FILES "${OpenMW_BINARY_DIR}/openmw.appdata.xml" DESTINATION "${DATAROOTDIR}/appdata" COMPONENT "openmw") INSTALL(FILES "${OpenMW_BINARY_DIR}/openmw.appdata.xml" DESTINATION "${DATAROOTDIR}/metainfo" COMPONENT "openmw")
IF(BUILD_OPENCS) IF(BUILD_OPENCS)
INSTALL(FILES "${OpenMW_BINARY_DIR}/openmw-cs.desktop" DESTINATION "${DATAROOTDIR}/applications" COMPONENT "opencs") INSTALL(FILES "${OpenMW_BINARY_DIR}/openmw-cs.desktop" DESTINATION "${DATAROOTDIR}/applications" COMPONENT "opencs")
INSTALL(FILES "${OpenMW_SOURCE_DIR}/files/opencs/openmw-cs.png" DESTINATION "${ICONDIR}" COMPONENT "opencs") INSTALL(FILES "${OpenMW_SOURCE_DIR}/files/opencs/openmw-cs.png" DESTINATION "${ICONDIR}" COMPONENT "opencs")

1
docs/requirements.txt
View file

@ -1,3 +1,2 @@
breathe
parse_cmake parse_cmake
sphinx sphinx

40
docs/source/conf.py
View file

@ -11,7 +11,6 @@
# #
# All configuration values have a default; values that are commented out # All configuration values have a default; values that are commented out
# serve to show the default. # serve to show the default.
import glob
import os import os
import sys import sys
@ -21,12 +20,6 @@ import sys
project_root = os.path.abspath('../../') project_root = os.path.abspath('../../')
sys.path.insert(0, project_root) 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 ------------------------------------------------ # -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here. # If your documentation needs a minimal Sphinx version, state it here.
@ -43,37 +36,6 @@ extensions = [
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
] ]
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. # Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates'] templates_path = ['_templates']
@ -88,7 +50,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'OpenMW' 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 # The version info for the project you're documenting, acts as replacement for

11
docs/source/index.rst
View file

@ -5,16 +5,7 @@ Sections
-------- --------
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
manuals/index manuals/index
reference/index reference/index
source/index
Indices and Tables
==================
* :ref:`genindex`
* :ref:`search`

8
docs/source/source/index.rst
View file

@ -1,8 +0,0 @@
Project Source Documentation
============================
.. toctree::
:maxdepth: 2
openmw/index
opencs/index

11
docs/source/source/opencs/index.rst
View file

@ -1,11 +0,0 @@
OpenMW-CS Source Documentation
##############################
.. toctree::
:maxdepth: 2
model/index
view/index
.. autodoxygenfile:: editor.hpp
:project: opencs

358
docs/source/source/opencs/model/index.rst
View file

@ -1,358 +0,0 @@
./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

340
docs/source/source/opencs/view/index.rst
View file

@ -1,340 +0,0 @@
./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
.. autodoxygenfile:: view/tools/reportsubview.hpp
:project: opencs
.. autodoxygenfile:: view/tools/reporttable.hpp
:project: opencs
.. autodoxygenfile:: view/tools/searchbox.hpp
:project: opencs
.. autodoxygenfile:: view/tools/searchsubview.hpp
:project: opencs
.. autodoxygenfile:: view/tools/subviews.hpp
:project: opencs
widget
------
.. autodoxygenfile:: view/widget/coloreditor.hpp
:project: opencs
.. autodoxygenfile:: view/widget/colorpickerpopup.hpp
:project: opencs
.. autodoxygenfile:: view/widget/completerpopup.hpp
:project: opencs
.. autodoxygenfile:: view/widget/droplineedit.hpp
:project: opencs
.. autodoxygenfile:: view/widget/modebutton.hpp
:project: opencs
.. autodoxygenfile:: view/widget/pushbutton.hpp
:project: opencs
.. autodoxygenfile:: view/widget/scenetoolbar.hpp
:project: opencs
.. autodoxygenfile:: view/widget/scenetool.hpp
:project: opencs
.. autodoxygenfile:: view/widget/scenetoolmode.hpp
:project: opencs
.. autodoxygenfile:: view/widget/scenetoolrun.hpp
:project: opencs
.. autodoxygenfile:: view/widget/scenetooltoggle2.hpp
:project: opencs
.. autodoxygenfile:: view/widget/scenetooltoggle.hpp
:project: opencs
world
-----
.. autodoxygenfile:: view/world/cellcreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/colordelegate.hpp
:project: opencs
.. autodoxygenfile:: view/world/creator.hpp
:project: opencs
.. autodoxygenfile:: view/world/datadisplaydelegate.hpp
:project: opencs
.. autodoxygenfile:: view/world/dialoguecreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/dialoguespinbox.hpp
:project: opencs
.. autodoxygenfile:: view/world/dialoguesubview.hpp
:project: opencs
.. autodoxygenfile:: view/world/dragdroputils.hpp
:project: opencs
.. autodoxygenfile:: view/world/dragrecordtable.hpp
:project: opencs
.. autodoxygenfile:: view/world/enumdelegate.hpp
:project: opencs
.. autodoxygenfile:: view/world/extendedcommandconfigurator.hpp
:project: opencs
.. autodoxygenfile:: view/world/genericcreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/globalcreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/idcompletiondelegate.hpp
:project: opencs
.. autodoxygenfile:: view/world/idtypedelegate.hpp
:project: opencs
.. autodoxygenfile:: view/world/idvalidator.hpp
:project: opencs
.. autodoxygenfile:: view/world/infocreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/nestedtable.hpp
:project: opencs
.. autodoxygenfile:: view/world/pathgridcreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/previewsubview.hpp
:project: opencs
.. autodoxygenfile:: view/world/recordbuttonbar.hpp
:project: opencs
.. autodoxygenfile:: view/world/recordstatusdelegate.hpp
:project: opencs
.. autodoxygenfile:: view/world/referenceablecreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/referencecreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/regionmap.hpp
:project: opencs
.. autodoxygenfile:: view/world/regionmapsubview.hpp
:project: opencs
.. autodoxygenfile:: view/world/scenesubview.hpp
:project: opencs
.. autodoxygenfile:: view/world/scriptedit.hpp
:project: opencs
.. autodoxygenfile:: view/world/scripterrortable.hpp
:project: opencs
.. autodoxygenfile:: view/world/scripthighlighter.hpp
:project: opencs
.. autodoxygenfile:: view/world/scriptsubview.hpp
:project: opencs
.. autodoxygenfile:: view/world/startscriptcreator.hpp
:project: opencs
.. autodoxygenfile:: view/world/subviews.hpp
:project: opencs
.. autodoxygenfile:: view/world/tablebottombox.hpp
:project: opencs
.. autodoxygenfile:: view/world/tableeditidaction.hpp
:project: opencs
.. autodoxygenfile:: view/world/table.hpp
:project: opencs
.. autodoxygenfile:: view/world/tablesubview.hpp
:project: opencs
.. autodoxygenfile:: view/world/util.hpp
:project: opencs
.. autodoxygenfile:: view/world/vartypedelegate.hpp
:project: opencs

24
docs/source/source/openmw/index.rst
View file

@ -1,24 +0,0 @@
OpenMW Source Documentation
###########################
.. toctree::
:maxdepth: 2
mwbase
mwclass
mwdialogue
mwgui
mwinput
mwmechanics
mwphysics
mwrender
mwscript
mwsound
mwstate
mwworld
.. autodoxygenfile:: engine.hpp
:project: openmw
.. autodoxygenfile:: doc.hpp
:project: openmw

32
docs/source/source/openmw/mwbase.rst
View file

@ -1,32 +0,0 @@
./mwbase
########
.. autodoxygenfile:: mwbase/dialoguemanager.hpp
:project: openmw
.. autodoxygenfile:: mwbase/environment.hpp
:project: openmw
.. autodoxygenfile:: mwbase/inputmanager.hpp
:project: openmw
.. autodoxygenfile:: mwbase/journal.hpp
:project: openmw
.. autodoxygenfile:: mwbase/mechanicsmanager.hpp
:project: openmw
.. autodoxygenfile:: mwbase/scriptmanager.hpp
:project: openmw
.. autodoxygenfile:: mwbase/soundmanager.hpp
:project: openmw
.. autodoxygenfile:: mwbase/statemanager.hpp
:project: openmw
.. autodoxygenfile:: mwbase/windowmanager.hpp
:project: openmw
.. autodoxygenfile:: mwbase/world.hpp
:project: openmw

68
docs/source/source/openmw/mwclass.rst
View file

@ -1,68 +0,0 @@
./mwclass
#########
.. autodoxygenfile:: mwclass/activator.hpp
:project: openmw
.. autodoxygenfile:: mwclass/actor.hpp
:project: openmw
.. autodoxygenfile:: mwclass/apparatus.hpp
:project: openmw
.. autodoxygenfile:: mwclass/armor.hpp
:project: openmw
.. autodoxygenfile:: mwclass/bodypart.hpp
:project: openmw
.. autodoxygenfile:: mwclass/book.hpp
:project: openmw
.. autodoxygenfile:: mwclass/classes.hpp
:project: openmw
.. autodoxygenfile:: mwclass/clothing.hpp
:project: openmw
.. autodoxygenfile:: mwclass/container.hpp
:project: openmw
.. autodoxygenfile:: mwclass/creature.hpp
:project: openmw
.. autodoxygenfile:: mwclass/creaturelevlist.hpp
:project: openmw
.. autodoxygenfile:: mwclass/ingredient.hpp
:project: openmw
.. autodoxygenfile:: mwclass/itemlevlist.hpp
:project: openmw
.. autodoxygenfile:: mwclass/light.hpp
:project: openmw
.. autodoxygenfile:: mwclass/lockpick.hpp
:project: openmw
.. autodoxygenfile:: mwclass/misc.hpp
:project: openmw
.. autodoxygenfile:: mwclass/npc.hpp
:project: openmw
.. autodoxygenfile:: mwclass/potion.hpp
:project: openmw
.. autodoxygenfile:: mwclass/probe.hpp
:project: openmw
.. autodoxygenfile:: mwclass/repair.hpp
:project: openmw
.. autodoxygenfile:: mwclass/static.hpp
:project: openmw
.. autodoxygenfile:: mwclass/weapon.hpp
:project: openmw

32
docs/source/source/openmw/mwdialogue.rst
View file

@ -1,32 +0,0 @@
./mwdialogue
############
.. autodoxygenfile:: mwdialogue/dialoguemanagerimp.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/filter.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/hypertextparser.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/journalentry.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/journalimp.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/keywordsearch.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/quest.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/scripttest.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/selectwrapper.hpp
:project: openmw
.. autodoxygenfile:: mwdialogue/topic.hpp
:project: openmw

227
docs/source/source/openmw/mwgui.rst
View file

@ -1,227 +0,0 @@
./mwgui
#######
.. autodoxygenfile:: mwgui/alchemywindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/backgroundimage.hpp
:project: openmw
.. autodoxygenfile:: mwgui/birth.hpp
:project: openmw
.. autodoxygenfile:: mwgui/bookpage.hpp
:project: openmw
.. autodoxygenfile:: mwgui/bookwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/charactercreation.hpp
:project: openmw
.. autodoxygenfile:: mwgui/class.hpp
:project: openmw
.. autodoxygenfile:: mwgui/companionitemmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/companionwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/confirmationdialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/console.hpp
:project: openmw
.. autodoxygenfile:: mwgui/container.hpp
:project: openmw
.. autodoxygenfile:: mwgui/containeritemmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/controllers.hpp
:project: openmw
.. autodoxygenfile:: mwgui/countdialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/cursor.hpp
:project: openmw
.. autodoxygenfile:: mwgui/debugwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/dialogue.hpp
:project: openmw
.. autodoxygenfile:: mwgui/draganddrop.hpp
:project: openmw
.. autodoxygenfile:: mwgui/enchantingdialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/exposedwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/formatting.hpp
:project: openmw
.. autodoxygenfile:: mwgui/hud.hpp
:project: openmw
.. autodoxygenfile:: mwgui/inventoryitemmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/inventorywindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/itemchargeview.hpp
:project: openmw
.. autodoxygenfile:: mwgui/itemmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/itemselection.hpp
:project: openmw
.. autodoxygenfile:: mwgui/itemview.hpp
:project: openmw
.. autodoxygenfile:: mwgui/itemwidget.hpp
:project: openmw
.. autodoxygenfile:: mwgui/jailscreen.hpp
:project: openmw
.. autodoxygenfile:: mwgui/journalbooks.hpp
:project: openmw
.. autodoxygenfile:: mwgui/journalviewmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/journalwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/layout.hpp
:project: openmw
.. autodoxygenfile:: mwgui/levelupdialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/loadingscreen.hpp
:project: openmw
.. autodoxygenfile:: mwgui/mainmenu.hpp
:project: openmw
.. autodoxygenfile:: mwgui/mapwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/merchantrepair.hpp
:project: openmw
.. autodoxygenfile:: mwgui/messagebox.hpp
:project: openmw
.. autodoxygenfile:: mwgui/mode.hpp
:project: openmw
.. autodoxygenfile:: mwgui/pickpocketitemmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/quickkeysmenu.hpp
:project: openmw
.. autodoxygenfile:: mwgui/race.hpp
:project: openmw
.. autodoxygenfile:: mwgui/recharge.hpp
:project: openmw
.. autodoxygenfile:: mwgui/referenceinterface.hpp
:project: openmw
.. autodoxygenfile:: mwgui/repair.hpp
:project: openmw
.. autodoxygenfile:: mwgui/review.hpp
:project: openmw
.. autodoxygenfile:: mwgui/savegamedialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/screenfader.hpp
:project: openmw
.. autodoxygenfile:: mwgui/scrollwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/settingswindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/sortfilteritemmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/soulgemdialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/spellbuyingwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/spellcreationdialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/spellicons.hpp
:project: openmw
.. autodoxygenfile:: mwgui/spellmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/spellview.hpp
:project: openmw
.. autodoxygenfile:: mwgui/spellwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/statswindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/textinput.hpp
:project: openmw
.. autodoxygenfile:: mwgui/timeadvancer.hpp
:project: openmw
.. autodoxygenfile:: mwgui/tooltips.hpp
:project: openmw
.. autodoxygenfile:: mwgui/tradeitemmodel.hpp
:project: openmw
.. autodoxygenfile:: mwgui/tradewindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/trainingwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/travelwindow.hpp
:project: openmw
.. autodoxygenfile:: mwgui/videowidget.hpp
:project: openmw
.. autodoxygenfile:: mwgui/waitdialog.hpp
:project: openmw
.. autodoxygenfile:: mwgui/widgets.hpp
:project: openmw
.. autodoxygenfile:: mwgui/windowbase.hpp
:project: openmw
.. autodoxygenfile:: mwgui/windowmanagerimp.hpp
:project: openmw
.. autodoxygenfile:: mwgui/windowpinnablebase.hpp
:project: openmw

5
docs/source/source/openmw/mwinput.rst
View file

@ -1,5 +0,0 @@
./mwinput
#########
.. autodoxygenfile:: mwinput/inputmanagerimp.hpp
:project: openmw

137
docs/source/source/openmw/mwmechanics.rst
View file

@ -1,137 +0,0 @@
./mwmechanics
#############
.. autodoxygenfile:: mwmechanics/activespells.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/actor.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/actors.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/actorutil.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aiactivate.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aiavoiddoor.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aicombataction.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aicombat.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aiescort.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aiface.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aifollow.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aipackage.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aipursue.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aisequence.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aistate.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aitravel.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/aiwander.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/alchemy.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/autocalcspell.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/character.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/combat.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/coordinateconverter.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/creaturestats.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/difficultyscaling.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/disease.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/drawstate.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/enchanting.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/levelledlist.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/magiceffects.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/mechanicsmanagerimp.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/movement.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/npcstats.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/objects.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/obstacle.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/pathfinding.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/pathgrid.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/pickpocket.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/repair.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/security.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/spellcasting.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/spells.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/stat.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/steering.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/summoning.hpp
:project: openmw
.. autodoxygenfile:: mwmechanics/trading.hpp
:project: openmw

15
docs/source/source/openmw/mwphysics.rst
View file

@ -1,15 +0,0 @@
./mwphysics
###########
.. autodoxygenfile:: mwphysics/actor.hpp
:project: openmw
.. autodoxygenfile:: mwphysics/collisiontype.hpp
:project: openmw
.. autodoxygenfile:: mwphysics/convert.hpp
:project: openmw
.. autodoxygenfile:: mwphysics/physicssystem.hpp
:project: openmw

77
docs/source/source/openmw/mwrender.rst
View file

@ -1,77 +0,0 @@
./mwrender
##########
.. autodoxygenfile:: mwrender/actoranimation.hpp
:project: openmw
.. autodoxygenfile:: mwrender/animation.hpp
:project: openmw
.. autodoxygenfile:: mwrender/bulletdebugdraw.hpp
:project: openmw
.. autodoxygenfile:: mwrender/camera.hpp
:project: openmw
.. autodoxygenfile:: mwrender/cell.hpp
:project: openmw
.. autodoxygenfile:: mwrender/characterpreview.hpp
:project: openmw
.. autodoxygenfile:: mwrender/creatureanimation.hpp
:project: openmw
.. autodoxygenfile:: mwrender/effectmanager.hpp
:project: openmw
.. autodoxygenfile:: mwrender/globalmap.hpp
:project: openmw
.. autodoxygenfile:: mwrender/localmap.hpp
:project: openmw
.. autodoxygenfile:: mwrender/npcanimation.hpp
:project: openmw
.. autodoxygenfile:: mwrender/objects.hpp
:project: openmw
.. autodoxygenfile:: mwrender/pathgrid.hpp
:project: openmw
.. autodoxygenfile:: mwrender/renderbin.hpp
:project: openmw
.. autodoxygenfile:: mwrender/renderinginterface.hpp
:project: openmw
.. autodoxygenfile:: mwrender/renderingmanager.hpp
:project: openmw
.. autodoxygenfile:: mwrender/rendermode.hpp
:project: openmw
.. autodoxygenfile:: mwrender/ripplesimulation.hpp
:project: openmw
.. autodoxygenfile:: mwrender/rotatecontroller.hpp
:project: openmw
.. autodoxygenfile:: mwrender/sky.hpp
:project: openmw
.. autodoxygenfile:: mwrender/terrainstorage.hpp
:project: openmw
.. autodoxygenfile:: mwrender/util.hpp
:project: openmw
.. autodoxygenfile:: mwrender/vismask.hpp
:project: openmw
.. autodoxygenfile:: mwrender/water.hpp
:project: openmw
.. autodoxygenfile:: mwrender/weaponanimation.hpp
:project: openmw

65
docs/source/source/openmw/mwscript.rst
View file

@ -1,65 +0,0 @@
./mwscript
##########
.. autodoxygenfile:: mwscript/aiextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/animationextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/cellextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/compilercontext.hpp
:project: openmw
.. autodoxygenfile:: mwscript/consoleextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/containerextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/controlextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/dialogueextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/extensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/globalscripts.hpp
:project: openmw
.. autodoxygenfile:: mwscript/guiextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/interpretercontext.hpp
:project: openmw
.. autodoxygenfile:: mwscript/locals.hpp
:project: openmw
.. autodoxygenfile:: mwscript/miscextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/ref.hpp
:project: openmw
.. autodoxygenfile:: mwscript/scriptmanagerimp.hpp
:project: openmw
.. autodoxygenfile:: mwscript/skyextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/soundextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/statsextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/transformationextensions.hpp
:project: openmw
.. autodoxygenfile:: mwscript/userextensions.hpp
:project: openmw

29
docs/source/source/openmw/mwsound.rst
View file

@ -1,29 +0,0 @@
./mwsound
#########
.. autodoxygenfile:: mwsound/ffmpeg_decoder.hpp
:project: openmw
.. autodoxygenfile:: mwsound/loudness.hpp
:project: openmw
.. autodoxygenfile:: mwsound/movieaudiofactory.hpp
:project: openmw
.. autodoxygenfile:: mwsound/openal_output.hpp
:project: openmw
.. autodoxygenfile:: mwsound/sound_buffer.hpp
:project: openmw
.. autodoxygenfile:: mwsound/sound_decoder.hpp
:project: openmw
.. autodoxygenfile:: mwsound/sound.hpp
:project: openmw
.. autodoxygenfile:: mwsound/soundmanagerimp.hpp
:project: openmw
.. autodoxygenfile:: mwsound/sound_output.hpp
:project: openmw

11
docs/source/source/openmw/mwstate.rst
View file

@ -1,11 +0,0 @@
./mwstate
#########
.. autodoxygenfile:: mwstate/character.hpp
:project: openmw
.. autodoxygenfile:: mwstate/charactermanager.hpp
:project: openmw
.. autodoxygenfile:: mwstate/statemanagerimp.hpp
:project: openmw

132
docs/source/source/openmw/mwworld.rst
View file

@ -1,132 +0,0 @@
./mwworld
#########
.. autodoxygenfile:: mwworld/actionalchemy.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actionapply.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actiondoor.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actioneat.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actionequip.hpp
:project: openmw
.. autodoxygenfile:: mwworld/action.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actionopen.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actionread.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actionrepair.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actionsoulgem.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actiontake.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actiontalk.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actionteleport.hpp
:project: openmw
.. autodoxygenfile:: mwworld/actiontrap.hpp
:project: openmw
.. autodoxygenfile:: mwworld/cellpreloader.hpp
:project: openmw
.. autodoxygenfile:: mwworld/cellref.hpp
:project: openmw
.. autodoxygenfile:: mwworld/cellreflist.hpp
:project: openmw
.. autodoxygenfile:: mwworld/cells.hpp
:project: openmw
.. autodoxygenfile:: mwworld/cellstore.hpp
:project: openmw
.. autodoxygenfile:: mwworld/cellvisitors.hpp
:project: openmw
.. autodoxygenfile:: mwworld/class.hpp
:project: openmw
.. autodoxygenfile:: mwworld/containerstore.hpp
:project: openmw
.. autodoxygenfile:: mwworld/contentloader.hpp
:project: openmw
.. autodoxygenfile:: mwworld/customdata.hpp
:project: openmw
.. autodoxygenfile:: mwworld/esmloader.hpp
:project: openmw
.. autodoxygenfile:: mwworld/esmstore.hpp
:project: openmw
.. autodoxygenfile:: mwworld/failedaction.hpp
:project: openmw
.. autodoxygenfile:: mwworld/globals.hpp
:project: openmw
.. autodoxygenfile:: mwworld/inventorystore.hpp
:project: openmw
.. autodoxygenfile:: mwworld/livecellref.hpp
:project: openmw
.. autodoxygenfile:: mwworld/localscripts.hpp
:project: openmw
.. autodoxygenfile:: mwworld/manualref.hpp
:project: openmw
.. autodoxygenfile:: mwworld/nullaction.hpp
:project: openmw
.. autodoxygenfile:: mwworld/player.hpp
:project: openmw
.. autodoxygenfile:: mwworld/projectilemanager.hpp
:project: openmw
.. autodoxygenfile:: mwworld/ptr.hpp
:project: openmw
.. autodoxygenfile:: mwworld/recordcmp.hpp
:project: openmw
.. autodoxygenfile:: mwworld/refdata.hpp
:project: openmw
.. autodoxygenfile:: mwworld/scene.hpp
:project: openmw
.. autodoxygenfile:: mwworld/store.hpp
:project: openmw
.. autodoxygenfile:: mwworld/timestamp.hpp
:project: openmw
.. autodoxygenfile:: mwworld/weather.hpp
:project: openmw
.. autodoxygenfile:: mwworld/worldimp.hpp
:project: openmw