forked from teamnwah/openmw-tes3coop
add beginning of openmw-cs docs
This commit is contained in:
parent
79956e4b49
commit
a39b593b9b
5 changed files with 69 additions and 3 deletions
|
@ -55,12 +55,23 @@ openmw_sub_dirs = os.walk(openmw_path).next()[1]
|
||||||
openmw_headers = insensitive_glob(os.path.join(openmw_path, "*.hpp"))
|
openmw_headers = insensitive_glob(os.path.join(openmw_path, "*.hpp"))
|
||||||
for dir in openmw_sub_dirs:
|
for dir in openmw_sub_dirs:
|
||||||
openmw_headers += insensitive_glob(os.path.join(openmw_path, dir, "*.hpp"))
|
openmw_headers += insensitive_glob(os.path.join(openmw_path, dir, "*.hpp"))
|
||||||
|
|
||||||
# massage the headers to get the relative path needed
|
# massage the headers to get the relative path needed
|
||||||
openmw_headers = [os.path.relpath(x, openmw_path) for x in openmw_headers]
|
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 = {
|
breathe_projects_source = {
|
||||||
"openmw": (openmw_path, openmw_headers)
|
"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.
|
||||||
|
|
|
@ -5,3 +5,4 @@ Project Source Documentation
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
openmw/index
|
openmw/index
|
||||||
|
opencs/index
|
11
docs/source/source/opencs/index.rst
Normal file
11
docs/source/source/opencs/index.rst
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
OpenMW-CS Source Documentation
|
||||||
|
##############################
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
model/index
|
||||||
|
view/index
|
||||||
|
|
||||||
|
.. autodoxygenfile:: editor.hpp
|
||||||
|
:project: opencs
|
41
docs/source/source/opencs/model/index.rst
Normal file
41
docs/source/source/opencs/model/index.rst
Normal file
|
@ -0,0 +1,41 @@
|
||||||
|
./opencs/model
|
||||||
|
##############
|
||||||
|
|
||||||
|
.. 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
|
2
docs/source/source/opencs/view/index.rst
Normal file
2
docs/source/source/opencs/view/index.rst
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
./opencs/view
|
||||||
|
#############
|
Loading…
Reference in a new issue