diff --git a/docs/source/conf.py b/docs/source/conf.py index fe7b72d8b..63016d53a 100644 --- a/docs/source/conf.py +++ b/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 diff --git a/docs/source/index.rst b/docs/source/index.rst index fdcb6ddaf..f51cda909 100644 --- a/docs/source/index.rst +++ b/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` diff --git a/docs/source/manuals/index.rst b/docs/source/manuals/index.rst new file mode 100644 index 000000000..2bf1fff5e --- /dev/null +++ b/docs/source/manuals/index.rst @@ -0,0 +1,7 @@ +User Manuals +============ + +.. toctree:: + :maxdepth: 2 + + openmw-cs/index diff --git a/docs/source/openmw-cs/_static/images/chapter-1/add-record.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/add-record.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/add-record.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/add-record.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/edit-record.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/edit-record.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/edit-record.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/edit-record.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/new-project.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/new-project.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/new-project.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/new-project.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/objects.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/objects.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/objects.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/objects.png diff --git a/docs/source/openmw-cs/_static/images/chapter-1/opening-dialogue.png b/docs/source/manuals/openmw-cs/_static/images/chapter-1/opening-dialogue.png similarity index 100% rename from docs/source/openmw-cs/_static/images/chapter-1/opening-dialogue.png rename to docs/source/manuals/openmw-cs/_static/images/chapter-1/opening-dialogue.png diff --git a/docs/source/openmw-cs/files-and-directories.rst b/docs/source/manuals/openmw-cs/files-and-directories.rst similarity index 100% rename from docs/source/openmw-cs/files-and-directories.rst rename to docs/source/manuals/openmw-cs/files-and-directories.rst diff --git a/docs/source/openmw-cs/foreword.rst b/docs/source/manuals/openmw-cs/foreword.rst similarity index 100% rename from docs/source/openmw-cs/foreword.rst rename to docs/source/manuals/openmw-cs/foreword.rst diff --git a/docs/source/openmw-cs/index.rst b/docs/source/manuals/openmw-cs/index.rst similarity index 51% rename from docs/source/openmw-cs/index.rst rename to docs/source/manuals/openmw-cs/index.rst index dcd28081a..c9f682f17 100644 --- a/docs/source/openmw-cs/index.rst +++ b/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 diff --git a/docs/source/openmw-cs/starting-dialog.rst b/docs/source/manuals/openmw-cs/starting-dialog.rst similarity index 100% rename from docs/source/openmw-cs/starting-dialog.rst rename to docs/source/manuals/openmw-cs/starting-dialog.rst diff --git a/docs/source/openmw-cs/tour.rst b/docs/source/manuals/openmw-cs/tour.rst similarity index 100% rename from docs/source/openmw-cs/tour.rst rename to docs/source/manuals/openmw-cs/tour.rst diff --git a/docs/source/openmw-mods/index.rst b/docs/source/openmw-mods/index.rst deleted file mode 100644 index 84e8b3335..000000000 --- a/docs/source/openmw-mods/index.rst +++ /dev/null @@ -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 \ No newline at end of file diff --git a/docs/source/openmw/index.rst b/docs/source/openmw/index.rst deleted file mode 100644 index ad9a87138..000000000 --- a/docs/source/openmw/index.rst +++ /dev/null @@ -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` diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst new file mode 100644 index 000000000..500936059 --- /dev/null +++ b/docs/source/reference/index.rst @@ -0,0 +1,7 @@ +Reference Material +================== + +.. toctree:: + :maxdepth: 2 + + modding/index \ No newline at end of file diff --git a/docs/source/openmw-mods/convert_bump_mapped_mods.rst b/docs/source/reference/modding/convert_bump_mapped_mods.rst similarity index 100% rename from docs/source/openmw-mods/convert_bump_mapped_mods.rst rename to docs/source/reference/modding/convert_bump_mapped_mods.rst diff --git a/docs/source/openmw-mods/differences.rst b/docs/source/reference/modding/differences.rst similarity index 100% rename from docs/source/openmw-mods/differences.rst rename to docs/source/reference/modding/differences.rst diff --git a/docs/source/openmw-mods/font.rst b/docs/source/reference/modding/font.rst similarity index 100% rename from docs/source/openmw-mods/font.rst rename to docs/source/reference/modding/font.rst diff --git a/docs/source/openmw-mods/foreword.rst b/docs/source/reference/modding/foreword.rst similarity index 100% rename from docs/source/openmw-mods/foreword.rst rename to docs/source/reference/modding/foreword.rst diff --git a/docs/source/reference/modding/index.rst b/docs/source/reference/modding/index.rst new file mode 100644 index 000000000..d2dd90850 --- /dev/null +++ b/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 diff --git a/docs/source/openmw-mods/mod-install.rst b/docs/source/reference/modding/mod-install.rst similarity index 100% rename from docs/source/openmw-mods/mod-install.rst rename to docs/source/reference/modding/mod-install.rst diff --git a/docs/source/openmw-mods/paths.rst b/docs/source/reference/modding/paths.rst similarity index 100% rename from docs/source/openmw-mods/paths.rst rename to docs/source/reference/modding/paths.rst diff --git a/docs/source/openmw-mods/settings/GUI.rst b/docs/source/reference/modding/settings/GUI.rst similarity index 100% rename from docs/source/openmw-mods/settings/GUI.rst rename to docs/source/reference/modding/settings/GUI.rst diff --git a/docs/source/openmw-mods/settings/HUD.rst b/docs/source/reference/modding/settings/HUD.rst similarity index 100% rename from docs/source/openmw-mods/settings/HUD.rst rename to docs/source/reference/modding/settings/HUD.rst diff --git a/docs/source/openmw-mods/settings/camera.rst b/docs/source/reference/modding/settings/camera.rst similarity index 100% rename from docs/source/openmw-mods/settings/camera.rst rename to docs/source/reference/modding/settings/camera.rst diff --git a/docs/source/openmw-mods/settings/cells.rst b/docs/source/reference/modding/settings/cells.rst similarity index 100% rename from docs/source/openmw-mods/settings/cells.rst rename to docs/source/reference/modding/settings/cells.rst diff --git a/docs/source/openmw-mods/settings/game.rst b/docs/source/reference/modding/settings/game.rst similarity index 100% rename from docs/source/openmw-mods/settings/game.rst rename to docs/source/reference/modding/settings/game.rst diff --git a/docs/source/openmw-mods/settings/general.rst b/docs/source/reference/modding/settings/general.rst similarity index 100% rename from docs/source/openmw-mods/settings/general.rst rename to docs/source/reference/modding/settings/general.rst diff --git a/docs/source/openmw-mods/settings/index.rst b/docs/source/reference/modding/settings/index.rst similarity index 100% rename from docs/source/openmw-mods/settings/index.rst rename to docs/source/reference/modding/settings/index.rst diff --git a/docs/source/openmw-mods/settings/input.rst b/docs/source/reference/modding/settings/input.rst similarity index 100% rename from docs/source/openmw-mods/settings/input.rst rename to docs/source/reference/modding/settings/input.rst diff --git a/docs/source/openmw-mods/settings/map.rst b/docs/source/reference/modding/settings/map.rst similarity index 100% rename from docs/source/openmw-mods/settings/map.rst rename to docs/source/reference/modding/settings/map.rst diff --git a/docs/source/openmw-mods/settings/saves.rst b/docs/source/reference/modding/settings/saves.rst similarity index 100% rename from docs/source/openmw-mods/settings/saves.rst rename to docs/source/reference/modding/settings/saves.rst diff --git a/docs/source/openmw-mods/settings/sound.rst b/docs/source/reference/modding/settings/sound.rst similarity index 100% rename from docs/source/openmw-mods/settings/sound.rst rename to docs/source/reference/modding/settings/sound.rst diff --git a/docs/source/openmw-mods/settings/video.rst b/docs/source/reference/modding/settings/video.rst similarity index 100% rename from docs/source/openmw-mods/settings/video.rst rename to docs/source/reference/modding/settings/video.rst diff --git a/docs/source/openmw-mods/settings/water.rst b/docs/source/reference/modding/settings/water.rst similarity index 100% rename from docs/source/openmw-mods/settings/water.rst rename to docs/source/reference/modding/settings/water.rst diff --git a/docs/source/openmw-mods/settings/windows.rst b/docs/source/reference/modding/settings/windows.rst similarity index 100% rename from docs/source/openmw-mods/settings/windows.rst rename to docs/source/reference/modding/settings/windows.rst diff --git a/docs/source/source/index.rst b/docs/source/source/index.rst new file mode 100644 index 000000000..36ac318fd --- /dev/null +++ b/docs/source/source/index.rst @@ -0,0 +1,7 @@ +Project Source Documentation +============================ + +.. toctree:: + :maxdepth: 2 + + openmw/index \ No newline at end of file diff --git a/docs/source/source/openmw/index.rst b/docs/source/source/openmw/index.rst new file mode 100644 index 000000000..b602c39a6 --- /dev/null +++ b/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 diff --git a/docs/source/openmw/mwbase.rst b/docs/source/source/openmw/mwbase.rst similarity index 98% rename from docs/source/openmw/mwbase.rst rename to docs/source/source/openmw/mwbase.rst index 39039d7c1..8fd7ffc1e 100644 --- a/docs/source/openmw/mwbase.rst +++ b/docs/source/source/openmw/mwbase.rst @@ -1,4 +1,3 @@ -######## ./mwbase ######## diff --git a/docs/source/openmw/mwclass.rst b/docs/source/source/openmw/mwclass.rst similarity index 97% rename from docs/source/openmw/mwclass.rst rename to docs/source/source/openmw/mwclass.rst index 951a8ffdb..3365d2582 100644 --- a/docs/source/openmw/mwclass.rst +++ b/docs/source/source/openmw/mwclass.rst @@ -1,4 +1,3 @@ -######### ./mwclass ######### diff --git a/docs/source/openmw/mwdialogue.rst b/docs/source/source/openmw/mwdialogue.rst similarity index 98% rename from docs/source/openmw/mwdialogue.rst rename to docs/source/source/openmw/mwdialogue.rst index f351437bd..1f3522f2c 100644 --- a/docs/source/openmw/mwdialogue.rst +++ b/docs/source/source/openmw/mwdialogue.rst @@ -1,4 +1,3 @@ -############ ./mwdialogue ############ diff --git a/docs/source/source/openmw/mwgui.rst b/docs/source/source/openmw/mwgui.rst new file mode 100644 index 000000000..0e3726832 --- /dev/null +++ b/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