Skip to content

Commit

Permalink
fix warnings, replace fonts with font, make breath/doxygen/cmake impo…
Browse files Browse the repository at this point in the history
…rts optional
  • Loading branch information
psi29a committed Feb 13, 2017
1 parent 051b403 commit 8d1c7ed
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 18 deletions.
Empty file added docs/source/_static/.keep
Empty file.
37 changes: 24 additions & 13 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,23 @@
'sphinx.ext.todo',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'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"])
}
try:
import breath

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:
pass

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand All @@ -71,10 +77,15 @@
# The short X.Y version.
# The full version, including alpha/beta/rc tags.

from parse_cmake import parsing
cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read()
cmake_data = parsing.parse(cmake_raw)
release = version = int(cmake_data[24][1][1].contents), int(cmake_data[25][1][1].contents), int(cmake_data[26][1][1].contents)
try:
from parse_cmake import parsing
cmake_raw = open(project_root+'/CMakeLists.txt', 'r').read()
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
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/openmw-mods/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ The following document is the complete reference guide to modifying, or modding,
differences
mod-install
settings/index
fonts
font
convert_bump_mapped_mods
paths
2 changes: 1 addition & 1 deletion docs/source/openmw-mods/settings/camera.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

small feature culling pixel size
---------------------
--------------------------------

:Type: floating point
:Range: > 0
Expand Down
2 changes: 1 addition & 1 deletion docs/source/openmw-mods/settings/water.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Water Settings
############
##############

.. 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.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/openmw-mods/settings/windows.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Windows Settings
############
################

:Type: floating point
:Range: 0.0 to 1.0
Expand Down
2 changes: 1 addition & 1 deletion docs/source/openmw/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
* :ref:`search`

0 comments on commit 8d1c7ed

Please sign in to comment.