reorganization and added mwgui

docs/source/conf.py

@@ -172,7 +172,7 @@ html_theme = 'default'
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static',
-                    'openmw-cs/_static'
+                    'manuals/openmw-cs/_static'
                     ]
 
 # Add any extra paths that contain custom files (such as robots.txt or

docs/source/index.rst

@@ -1,19 +1,18 @@
+Welcome to OpenMW's Documentation!
+==================================
 
-Welcome to OpenMW's documentation!
-=====================================
-
-Components
-----------
+Sections
+--------
 
 .. toctree::
     :maxdepth: 2
 
-    openmw/index
-    openmw-cs/index
-    openmw-mods/index
+    manuals/index
+    reference/index
+    source/index
 
 
-Indices and tables
+Indices and Tables
 ==================
 
 * :ref:`genindex`

docs/source/manuals/index.rst

@@ -0,0 +1,7 @@
+User Manuals
+============
+
+.. toctree::
+    :maxdepth: 2
+
+    openmw-cs/index

docs/source/manuals/openmw-cs/index.rst

@@ -1,5 +1,4 @@
-#####################
-OpenMW CS user manual
+OpenMW CS User Manual
 #####################
 
 The following document is the complete user manual for *OpenMW CS*, the
@@ -9,17 +8,17 @@ modding *The Elder Scrolls III: Morrowind* you should at least read the first
 few chapters to familiarise yourself with the new interface.
 
 .. warning::
-   OpenMW CS is still software in development. The manual does not cover any of
-   its shortcomings, it is written as if everything was working as inteded.
-   Please report any software problems as bugs in the software, not errors in
-   the manual.
+    OpenMW CS is still software in development. The manual does not cover any of
+    its shortcomings, it is written as if everything was working as inteded.
+    Please report any software problems as bugs in the software, not errors in
+    the manual.
 
 .. toctree::
-   :caption: Table of Contents
-   :maxdepth: 2
+    :caption: Table of Contents
+    :maxdepth: 2
 
-   foreword
-   tour
-   files-and-directories
-   starting-dialog
+    foreword
+    tour
+    files-and-directories
+    starting-dialog
 

docs/source/openmw-mods/index.rst

@@ -1,20 +0,0 @@
-########################
-OpenMW Modding Reference
-########################
-
-The following document is the complete reference guide to modifying, or modding, your OpenMW setup. It does not cover content creation itself, only how to alter or add to your OpenMW gameplay experience. To learn more about creating new content for OpenMW, please refer to :doc:`../openmw-cs/index`.
-
-.. warning::
-   OpenMW is still software in development. This manual does not cover any of its shortcomings. It is written as if everything was working as inteded. Please report any software problems as bugs in the software, not errors in the manual.
-
-.. toctree::
-   :caption: Table of Contents
-   :maxdepth: 2
-
-   foreword
-   differences
-   mod-install
-   settings/index
-   font
-   convert_bump_mapped_mods
-   paths

docs/source/openmw/index.rst

@@ -1,19 +0,0 @@
-###########################
-OpenMW Source Documentation
-###########################
-
-.. toctree::
-  :maxdepth: 2
-
-  mwbase
-  mwclass
-  mwdialogue
-
-.. autodoxygenfile:: engine.hpp
-  :project: openmw
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`search`

docs/source/reference/index.rst

@@ -0,0 +1,7 @@
+Reference Material
+==================
+
+.. toctree::
+    :maxdepth: 2
+
+    modding/index

docs/source/reference/modding/index.rst

@@ -0,0 +1,26 @@
+OpenMW Modding Reference
+########################
+
+The following document is the complete reference guide to modifying, or
+modding, your OpenMW setup. It does not cover content creation itself,
+only how to alter or add to your OpenMW gameplay experience. To learn more
+about creating new content for OpenMW, please refer to
+:doc:`/manuals/openmw-cs/index`.
+
+.. warning::
+    OpenMW is still software in development. This manual does not cover any
+    of its shortcomings. It is written as if everything was working as
+    intended. Please report any software problems as bugs in the software,
+    not errors in the manual.
+
+.. toctree::
+    :caption: Table of Contents
+    :maxdepth: 2
+
+    foreword
+    differences
+    mod-install
+    settings/index
+    font
+    convert_bump_mapped_mods
+    paths

docs/source/source/index.rst

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

docs/source/source/openmw/index.rst

@@ -0,0 +1,13 @@
+OpenMW Source Documentation
+###########################
+
+.. toctree::
+    :maxdepth: 2
+
+    mwbase
+    mwclass
+    mwdialogue
+    mwgui
+
+.. autodoxygenfile:: engine.hpp
+    :project: openmw

docs/source/source/openmw/mwbase.rst

@@ -1,4 +1,3 @@
-########
 ./mwbase
 ########
 

docs/source/source/openmw/mwclass.rst

@@ -1,4 +1,3 @@
-#########
 ./mwclass
 #########
 

docs/source/source/openmw/mwdialogue.rst

@@ -1,4 +1,3 @@
-############
 ./mwdialogue
 ############
 

docs/source/source/openmw/mwgui.rst

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