fix warnings, replace fonts with font, make breath/doxygen/cmake imports optional

pull/1205/head
Bret Curtis 8 years ago
parent 051b4038d9
commit 8d1c7edcf6

@ -35,17 +35,23 @@ extensions = [
'sphinx.ext.todo', 'sphinx.ext.todo',
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'breathe',
] ]
# Where breathe can find the source files try:
breathe_projects_source = { import breath
"openmw": (project_root+"/apps/openmw", ["engine.hpp",
"mwbase/dialoguemanager.hpp", "mwbase/environment.hpp", extensions.append('breathe')
"mwbase/inputmanager.hpp", "mwbase/journal.hpp", "mwbase/mechanicsmanager.hpp",
"mwbase/scriptmanager.hpp", "mwbase/soundmanager.hpp", "mwbase/statemanager.hpp", # Where breathe can find the source files
"mwbase/windowmanager.hpp", "mwbase/world.hpp"]) 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:
pass
# 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']
@ -71,10 +77,15 @@ copyright = u'2016, OpenMW Team'
# The short X.Y version. # The short X.Y version.
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
from parse_cmake import parsing try:
cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read() from parse_cmake import parsing
cmake_data = parsing.parse(cmake_raw) cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read()
release = version = int(cmake_data[24][1][1].contents), int(cmake_data[25][1][1].contents), int(cmake_data[26][1][1].contents) cmake_data = parsing.parse(cmake_raw)
release = version = '.'.join(int(cmake_data[24][1][1].contents),
int(cmake_data[25][1][1].contents),
int(cmake_data[26][1][1].contents))
except ImportError:
release = "UNRELEASED"
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.

@ -15,6 +15,6 @@ The following document is the complete reference guide to modifying, or modding,
differences differences
mod-install mod-install
settings/index settings/index
fonts font
convert_bump_mapped_mods convert_bump_mapped_mods
paths paths

@ -24,7 +24,7 @@ This setting determines whether objects that render to a few pixels or smaller w
The default value is true. This setting can only be configured by editing the settings configuration file. The default value is true. This setting can only be configured by editing the settings configuration file.
small feature culling pixel size small feature culling pixel size
--------------------- --------------------------------
:Type: floating point :Type: floating point
:Range: > 0 :Range: > 0

@ -1,5 +1,5 @@
Water Settings Water Settings
############ ##############
.. note:: .. note::
The settings for the water shader are difficult to describe, but can be seen immediately in the Water tab of the Video panel in the Options menu. Changes there will be saved to these settings. It is suggested to stand on the shore of a moderately broad body of water with trees or other objects on the far shore to test reflection textures, underwater plants in shallow water near by to test refraction textures, and some deep water visible from your location to test deep water visibility. The settings for the water shader are difficult to describe, but can be seen immediately in the Water tab of the Video panel in the Options menu. Changes there will be saved to these settings. It is suggested to stand on the shore of a moderately broad body of water with trees or other objects on the far shore to test reflection textures, underwater plants in shallow water near by to test refraction textures, and some deep water visible from your location to test deep water visibility.

@ -1,5 +1,5 @@
Windows Settings Windows Settings
############ ################
:Type: floating point :Type: floating point
:Range: 0.0 to 1.0 :Range: 0.0 to 1.0

@ -14,4 +14,4 @@ Indices and tables
================== ==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`search` * :ref:`search`

Loading…
Cancel
Save