mirror of
https://github.com/OpenMW/openmw.git
synced 2025-01-16 17:29:55 +00:00
use breathe not breath
This commit is contained in:
parent
6483218cb5
commit
8044663acd
4 changed files with 92 additions and 15 deletions
|
@ -38,21 +38,29 @@ extensions = [
|
||||||
]
|
]
|
||||||
|
|
||||||
try:
|
try:
|
||||||
import breath
|
import breathe
|
||||||
|
|
||||||
extensions.append('breathe')
|
extensions.append('breathe')
|
||||||
|
|
||||||
# Where breathe can find the source files
|
|
||||||
breathe_projects_source = {
|
|
||||||
"openmw": (project_root+"/apps/openmw", ["engine.hpp",
|
|
||||||
"mwbase/dialoguemanager.hpp", "mwbase/environment.hpp",
|
|
||||||
"mwbase/inputmanager.hpp", "mwbase/journal.hpp", "mwbase/mechanicsmanager.hpp",
|
|
||||||
"mwbase/scriptmanager.hpp", "mwbase/soundmanager.hpp", "mwbase/statemanager.hpp",
|
|
||||||
"mwbase/windowmanager.hpp", "mwbase/world.hpp"])
|
|
||||||
}
|
|
||||||
except ImportError:
|
except ImportError:
|
||||||
print("WARNING: Unable to import breathe, code documentation won't be generated.")
|
print("WARNING: Unable to import breathe, code documentation won't be generated.")
|
||||||
|
|
||||||
|
# Where breathe can find the source files
|
||||||
|
breathe_projects_source = {
|
||||||
|
"openmw": (project_root+"/apps/openmw",
|
||||||
|
["engine.hpp",
|
||||||
|
"mwbase/dialoguemanager.hpp", "mwbase/environment.hpp", "mwbase/inputmanager.hpp", "mwbase/journal.hpp",
|
||||||
|
"mwbase/mechanicsmanager.hpp", "mwbase/scriptmanager.hpp", "mwbase/soundmanager.hpp",
|
||||||
|
"mwbase/statemanager.hpp", "mwbase/windowmanager.hpp", "mwbase/world.hpp",
|
||||||
|
"mwclass/activator.hpp", "mwclass/book.hpp", "mwclass/creaturelevlist.hpp", "mwclass/lockpick.hpp",
|
||||||
|
"mwclass/repair.hpp", "mwclass/actor.hpp", "mwclass/classes.hpp", "mwclass/door.hpp",
|
||||||
|
"mwclass/misc.hpp", "mwclass/static.hpp", "mwclass/apparatus.hpp", "mwclass/clothing.hpp",
|
||||||
|
"mwclass/ingredient.hpp", "mwclass/npc.hpp", "mwclass/weapon.hpp", "mwclass/armor.hpp",
|
||||||
|
"mwclass/container.hpp", "mwclass/itemlevlist.hpp", "mwclass/potion.hpp",
|
||||||
|
"mwclass/bodypart.hpp", "mwclass/creature.hpp", "mwclass/light.hpp", "mwclass/probe.hpp",
|
||||||
|
|
||||||
|
|
||||||
|
])
|
||||||
|
}
|
||||||
|
|
||||||
# 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']
|
||||||
|
|
||||||
|
@ -81,9 +89,9 @@ try:
|
||||||
from parse_cmake import parsing
|
from parse_cmake import parsing
|
||||||
cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read()
|
cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read()
|
||||||
cmake_data = parsing.parse(cmake_raw)
|
cmake_data = parsing.parse(cmake_raw)
|
||||||
release = version = '.'.join(int(cmake_data[24][1][1].contents),
|
release = version = '.'.join([cmake_data[24][1][1].contents,
|
||||||
int(cmake_data[25][1][1].contents),
|
cmake_data[25][1][1].contents,
|
||||||
int(cmake_data[26][1][1].contents))
|
cmake_data[26][1][1].contents])
|
||||||
except ImportError:
|
except ImportError:
|
||||||
release = "UNRELEASED"
|
release = "UNRELEASED"
|
||||||
print("WARNING: Unable to import parse_cmake, version will be set to: {0}.".format(release))
|
print("WARNING: Unable to import parse_cmake, version will be set to: {0}.".format(release))
|
||||||
|
|
|
@ -6,6 +6,7 @@ OpenMW Source Documentation
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
mwbase
|
mwbase
|
||||||
|
mwclass
|
||||||
|
|
||||||
.. autodoxygenfile:: engine.hpp
|
.. autodoxygenfile:: engine.hpp
|
||||||
:project: openmw
|
:project: openmw
|
||||||
|
|
|
@ -31,4 +31,3 @@
|
||||||
|
|
||||||
.. autodoxygenfile:: mwbase/world.hpp
|
.. autodoxygenfile:: mwbase/world.hpp
|
||||||
:project: openmw
|
:project: openmw
|
||||||
|
|
||||||
|
|
69
docs/source/openmw/mwclass.rst
Normal file
69
docs/source/openmw/mwclass.rst
Normal file
|
@ -0,0 +1,69 @@
|
||||||
|
#########
|
||||||
|
./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
|
Loading…
Reference in a new issue