From ac8d347e9e7a3392f9ae3a81373977ad63942056 Mon Sep 17 00:00:00 2001 From: Bret Curtis Date: Tue, 5 Jul 2016 12:07:31 +0200 Subject: [PATCH 1/2] we have html output and autodoc functionality --- CMakeLists.txt | 4 + cmake/FindSphinx.cmake | 145 +++++++++++++++ docs/CMakeLists.txt | 27 +++ docs/sphinx/run_sphinx_build.sh.in | 7 + docs/sphinx/source/conf.py.in | 275 +++++++++++++++++++++++++++++ docs/sphinx/source/index.rst | 19 ++ docs/sphinx/source/mwbase.rst | 33 ++++ docs/sphinx/source/openmw.rst | 16 ++ 8 files changed, 526 insertions(+) create mode 100644 cmake/FindSphinx.cmake create mode 100644 docs/CMakeLists.txt create mode 100644 docs/sphinx/run_sphinx_build.sh.in create mode 100644 docs/sphinx/source/conf.py.in create mode 100644 docs/sphinx/source/index.rst create mode 100644 docs/sphinx/source/mwbase.rst create mode 100644 docs/sphinx/source/openmw.rst diff --git a/CMakeLists.txt b/CMakeLists.txt index 14a1c15c8..e5ecd1f62 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -829,3 +829,7 @@ if (DOXYGEN_FOUND) WORKING_DIRECTORY ${OpenMW_BINARY_DIR} COMMENT "Generating documentation for the github-pages at ${DOXYGEN_PAGES_OUTPUT_DIR}" VERBATIM) endif () + + +OPTION(WANT_DOCS "Build documentation." OFF ) +ADD_SUBDIRECTORY(docs) diff --git a/cmake/FindSphinx.cmake b/cmake/FindSphinx.cmake new file mode 100644 index 000000000..4607f7806 --- /dev/null +++ b/cmake/FindSphinx.cmake @@ -0,0 +1,145 @@ +# - This module looks for Sphinx +# Find the Sphinx documentation generator +# +# This modules defines +# SPHINX_EXECUTABLE +# SPHINX_FOUND + +find_program(SPHINX_EXECUTABLE + NAMES sphinx-build + PATHS + /usr/bin + /usr/local/bin + /opt/local/bin + DOC "Sphinx documentation generator" +) + +if( NOT SPHINX_EXECUTABLE ) + set(_Python_VERSIONS + 2.7 2.6 2.5 2.4 2.3 2.2 2.1 2.0 1.6 1.5 + ) + + foreach( _version ${_Python_VERSIONS} ) + set( _sphinx_NAMES sphinx-build-${_version} ) + + find_program( SPHINX_EXECUTABLE + NAMES ${_sphinx_NAMES} + PATHS + /usr/bin + /usr/local/bin + /opt/loca/bin + DOC "Sphinx documentation generator" + ) + endforeach() +endif() + +include(FindPackageHandleStandardArgs) + +find_package_handle_standard_args(Sphinx DEFAULT_MSG + SPHINX_EXECUTABLE +) + + +option( SPHINX_HTML_OUTPUT "Build a single HTML with the whole content." ON ) +option( SPHINX_DIRHTML_OUTPUT "Build HTML pages, but with a single directory per document." OFF ) +option( SPHINX_HTMLHELP_OUTPUT "Build HTML pages with additional information for building a documentation collection in htmlhelp." OFF ) +option( SPHINX_QTHELP_OUTPUT "Build HTML pages with additional information for building a documentation collection in qthelp." OFF ) +option( SPHINX_DEVHELP_OUTPUT "Build HTML pages with additional information for building a documentation collection in devhelp." OFF ) +option( SPHINX_EPUB_OUTPUT "Build HTML pages with additional information for building a documentation collection in epub." OFF ) +option( SPHINX_LATEX_OUTPUT "Build LaTeX sources that can be compiled to a PDF document using pdflatex." OFF ) +option( SPHINX_MAN_OUTPUT "Build manual pages in groff format for UNIX systems." OFF ) +option( SPHINX_TEXT_OUTPUT "Build plain text files." OFF ) + + +mark_as_advanced( + SPHINX_EXECUTABLE + SPHINX_HTML_OUTPUT + SPHINX_DIRHTML_OUTPUT + SPHINX_HTMLHELP_OUTPUT + SPHINX_QTHELP_OUTPUT + SPHINX_DEVHELP_OUTPUT + SPHINX_EPUB_OUTPUT + SPHINX_LATEX_OUTPUT + SPHINX_MAN_OUTPUT + SPHINX_TEXT_OUTPUT +) + +function( Sphinx_add_target target_name builder conf source destination ) + add_custom_target( ${target_name} ALL + COMMAND ${SPHINX_EXECUTABLE} -b ${builder} + -c ${conf} + ${source} + ${destination} + COMMENT "Generating sphinx documentation: ${builder}" + ) + + set_property( + DIRECTORY APPEND PROPERTY + ADDITIONAL_MAKE_CLEAN_FILES + ${destination} + ) +endfunction() + +# Target dependencies can be optionally listed at the end. +function( Sphinx_add_targets target_base_name conf source base_destination ) + + set( _dependencies ) + + foreach( arg IN LISTS ARGN ) + set( _dependencies ${_dependencies} ${arg} ) + endforeach() + + if( ${SPHINX_HTML_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_html html ${conf} ${source} ${base_destination}/html ) + + add_dependencies( ${target_base_name}_html ${_dependencies} ) + endif() + + if( ${SPHINX_DIRHTML_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_dirhtml dirhtml ${conf} ${source} ${base_destination}/dirhtml ) + + add_dependencies( ${target_base_name}_dirhtml ${_dependencies} ) + endif() + + if( ${SPHINX_QTHELP_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_qthelp qthelp ${conf} ${source} ${base_destination}/qthelp ) + + add_dependencies( ${target_base_name}_qthelp ${_dependencies} ) + endif() + + if( ${SPHINX_DEVHELP_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_devhelp devhelp ${conf} ${source} ${base_destination}/devhelp ) + + add_dependencies( ${target_base_name}_devhelp ${_dependencies} ) + endif() + + if( ${SPHINX_EPUB_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_epub epub ${conf} ${source} ${base_destination}/epub ) + + add_dependencies( ${target_base_name}_epub ${_dependencies} ) + endif() + + if( ${SPHINX_LATEX_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_latex latex ${conf} ${source} ${base_destination}/latex ) + + add_dependencies( ${target_base_name}_latex ${_dependencies} ) + endif() + + if( ${SPHINX_MAN_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_man man ${conf} ${source} ${base_destination}/man ) + + add_dependencies( ${target_base_name}_man ${_dependencies} ) + endif() + + if( ${SPHINX_TEXT_OUTPUT} ) + Sphinx_add_target( ${target_base_name}_text text ${conf} ${source} ${base_destination}/text ) + + add_dependencies( ${target_base_name}_text ${_dependencies} ) + endif() + + if( ${BUILD_TESTING} ) + sphinx_add_target( ${target_base_name}_linkcheck linkcheck ${conf} ${source} ${base_destination}/linkcheck ) + + add_dependencies( ${target_base_name}_linkcheck ${_dependencies} ) + endif() +endfunction() diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt new file mode 100644 index 000000000..c63d6dc18 --- /dev/null +++ b/docs/CMakeLists.txt @@ -0,0 +1,27 @@ +IF( WANT_DOCS ) + # Builds the documentation. + FIND_PACKAGE( Sphinx REQUIRED ) + FIND_PACKAGE( Doxygen REQUIRED ) + + SET( SPHINX_SOURCE_DIR ${CMAKE_SOURCE_DIR}/docs/sphinx ) + SET( DOCUMENTATION_DIR ${OpenMW_BINARY_DIR}/docs ) + + FILE(MAKE_DIRECTORY ${DOCUMENTATION_DIR}/_static) + FILE(MAKE_DIRECTORY ${DOCUMENTATION_DIR}/_templates) + + CONFIGURE_FILE( + ${SPHINX_SOURCE_DIR}/source/conf.py.in + ${DOCUMENTATION_DIR}/conf.py + @ONLY) + + CONFIGURE_FILE( + ${SPHINX_SOURCE_DIR}/run_sphinx_build.sh.in + ${DOCUMENTATION_DIR}/run_sphinx_build.sh + @ONLY) + + IF(UNIX) + EXECUTE_PROCESS(COMMAND chmod +x ${DOCUMENTATION_DIR}/run_sphinx_build.sh OUTPUT_QUIET) + EXECUTE_PROCESS(COMMAND ${DOCUMENTATION_DIR}/run_sphinx_build.sh OUTPUT_QUIET) + ENDIF(UNIX) + +ENDIF() diff --git a/docs/sphinx/run_sphinx_build.sh.in b/docs/sphinx/run_sphinx_build.sh.in new file mode 100644 index 000000000..ddd4dc2bb --- /dev/null +++ b/docs/sphinx/run_sphinx_build.sh.in @@ -0,0 +1,7 @@ +#!/bin/bash +echo "Creating Sphinx documentation in: @SPHINX_DESTINATION@" + +LD_LIBRARY_PATH="@CMAKE_INSTALL_PREFIX@/lib:$LD_LIBRARY_PATH" + +@SPHINX_EXECUTABLE@ -b html -c @CMAKE_CURRENT_BINARY_DIR@/ @SPHINX_SOURCE_DIR@/source @DOCUMENTATION_DIR@/html +@SPHINX_EXECUTABLE@ -b man -c @CMAKE_CURRENT_BINARY_DIR@/ @SPHINX_SOURCE_DIR@/source @DOCUMENTATION_DIR@/man \ No newline at end of file diff --git a/docs/sphinx/source/conf.py.in b/docs/sphinx/source/conf.py.in new file mode 100644 index 000000000..218ef8b6d --- /dev/null +++ b/docs/sphinx/source/conf.py.in @@ -0,0 +1,275 @@ +# -*- coding: utf-8 -*- +# +# OpenMW documentation build configuration file, created by +# sphinx-quickstart on Wed May 14 15:16:35 2014. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +sys.path.insert(0, os.path.abspath('@CMAKE_SOURCE_DIR@')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', + 'breathe', +] + +# Where breathe can find the source files +breathe_projects_source = { + "openmw": ("@CMAKE_SOURCE_DIR@/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"]) + } + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'OpenMW' +copyright = u'2016, OpenMW Team' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '@OPENMW_VERSION@' +# The full version, including alpha/beta/rc tags. +release = '@OPENMW_VERSION@' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +primary_domain = 'c' + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# 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'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'OpenMWdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'OpenMW.tex', u'OpenMW Documentation', + u'Bret Curtis', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'openmw', u'OpenMW Documentation', + [u'Bret Curtis'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'OpenMW', u'OpenMW Documentation', + u'Bret Curtis', 'OpenMW', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst new file mode 100644 index 000000000..64c3c9796 --- /dev/null +++ b/docs/sphinx/source/index.rst @@ -0,0 +1,19 @@ + +Welcome to OpenMW's documentation! +===================================== + +Components +---------- + +.. toctree:: + :maxdepth: 2 + + openmw + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`search` + diff --git a/docs/sphinx/source/mwbase.rst b/docs/sphinx/source/mwbase.rst new file mode 100644 index 000000000..4044fbc97 --- /dev/null +++ b/docs/sphinx/source/mwbase.rst @@ -0,0 +1,33 @@ +openmw/mwbase +============= + +.. autodoxygenfile:: mwbase/dialoguemanager.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/environment.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/inputmanager.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/journal.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/mechanicsmanager.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/scriptmanager.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/soundmanager.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/statemanager.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/windowmanager.hpp + :project: openmw + +.. autodoxygenfile:: mwbase/world.hpp + :project: openmw + diff --git a/docs/sphinx/source/openmw.rst b/docs/sphinx/source/openmw.rst new file mode 100644 index 000000000..2da7caa5f --- /dev/null +++ b/docs/sphinx/source/openmw.rst @@ -0,0 +1,16 @@ +openmw +====== + +.. toctree:: + :maxdepth: 2 + + mwbase + +.. autodoxygenfile:: engine.hpp + :project: openmw + +Indices and tables +================== + +* :ref:`genindex` + * :ref:`search` \ No newline at end of file From 7f0d5bde2d42b1a45e89b88ac08ebf77b3b4d7eb Mon Sep 17 00:00:00 2001 From: Bret Curtis Date: Thu, 7 Jul 2016 17:27:08 +0200 Subject: [PATCH 2/2] make conf.py independant from cmake macros merged openmw-cs in, using per directory statics add requirements.txt for sphinx docs it is breath update gitignore and openmw-cs --- .gitignore | 17 +- CMakeLists.txt | 12 +- docs/CMakeLists.txt | 27 -- docs/cs-manual/Makefile | 216 ----------- docs/cs-manual/make.bat | 263 ------------- docs/cs-manual/source/conf.py | 358 ------------------ docs/requirements.txt | 3 + .../source/conf.py.in => source/conf.py} | 19 +- docs/{sphinx => }/source/index.rst | 7 +- .../_static/images/chapter-1/add-record.png | Bin .../_static/images/chapter-1/edit-record.png | Bin .../_static/images/chapter-1/new-project.png | Bin .../_static/images/chapter-1/objects.png | Bin .../images/chapter-1/opening-dialogue.png | Bin .../openmw-cs}/files-and-directories.rst | 0 .../source => source/openmw-cs}/foreword.rst | 0 .../source => source/openmw-cs}/index.rst | 5 - .../openmw-cs}/starting-dialog.rst | 0 .../source => source/openmw-cs}/tour.rst | 10 +- .../openmw.rst => source/openmw/index.rst} | 5 +- .../source => source/openmw}/mwbase.rst | 5 +- docs/sphinx/run_sphinx_build.sh.in | 7 - 22 files changed, 46 insertions(+), 908 deletions(-) delete mode 100644 docs/CMakeLists.txt delete mode 100644 docs/cs-manual/Makefile delete mode 100644 docs/cs-manual/make.bat delete mode 100644 docs/cs-manual/source/conf.py create mode 100644 docs/requirements.txt rename docs/{sphinx/source/conf.py.in => source/conf.py} (94%) rename docs/{sphinx => }/source/index.rst (77%) rename docs/{cs-manual/source => source/openmw-cs}/_static/images/chapter-1/add-record.png (100%) rename docs/{cs-manual/source => source/openmw-cs}/_static/images/chapter-1/edit-record.png (100%) rename docs/{cs-manual/source => source/openmw-cs}/_static/images/chapter-1/new-project.png (100%) rename docs/{cs-manual/source => source/openmw-cs}/_static/images/chapter-1/objects.png (100%) rename docs/{cs-manual/source => source/openmw-cs}/_static/images/chapter-1/opening-dialogue.png (100%) rename docs/{cs-manual/source => source/openmw-cs}/files-and-directories.rst (100%) rename docs/{cs-manual/source => source/openmw-cs}/foreword.rst (100%) rename docs/{cs-manual/source => source/openmw-cs}/index.rst (78%) rename docs/{cs-manual/source => source/openmw-cs}/starting-dialog.rst (100%) rename docs/{cs-manual/source => source/openmw-cs}/tour.rst (97%) rename docs/{sphinx/source/openmw.rst => source/openmw/index.rst} (66%) rename docs/{sphinx/source => source/openmw}/mwbase.rst (95%) delete mode 100644 docs/sphinx/run_sphinx_build.sh.in diff --git a/.gitignore b/.gitignore index b68d13cde..9a24b0107 100644 --- a/.gitignore +++ b/.gitignore @@ -10,7 +10,6 @@ prebuilt ## doxygen Doxygen -!docs/cs-manual/Makefile ## ides/editors *~ @@ -35,17 +34,15 @@ resources ## binaries /esmtool -/mwiniimport -/omwlauncher /openmw /opencs /niftest -bsatool -openmw-cs -openmw-essimporter -openmw-iniimporter -openmw-launcher -openmw-wizard +/bsatool +/openmw-cs +/openmw-essimporter +/openmw-iniimporter +/openmw-launcher +/openmw-wizard ## generated objects apps/openmw/config.hpp @@ -80,4 +77,4 @@ moc_*.cxx *.so gamecontrollerdb.txt openmw.appdata.xml - +venv/ diff --git a/CMakeLists.txt b/CMakeLists.txt index e5ecd1f62..8db1e1aa5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -76,6 +76,14 @@ option(BUILD_WITH_CODE_COVERAGE "Enable code coverage with gconv" OFF) option(BUILD_UNITTESTS "Enable Unittests with Google C++ Unittest" OFF) option(BUILD_NIFTEST "build nif file tester" OFF) option(BUILD_MYGUI_PLUGIN "build MyGUI plugin for OpenMW resources, to use with MyGUI tools" ON) +option(BUILD_DOCS "build documentation." OFF ) + +# what is necessary to build documentation +IF( BUILD_DOCS ) + # Builds the documentation. + FIND_PACKAGE( Sphinx REQUIRED ) + FIND_PACKAGE( Doxygen REQUIRED ) +ENDIF() # OS X deployment option(OPENMW_OSX_DEPLOYMENT OFF) @@ -829,7 +837,3 @@ if (DOXYGEN_FOUND) WORKING_DIRECTORY ${OpenMW_BINARY_DIR} COMMENT "Generating documentation for the github-pages at ${DOXYGEN_PAGES_OUTPUT_DIR}" VERBATIM) endif () - - -OPTION(WANT_DOCS "Build documentation." OFF ) -ADD_SUBDIRECTORY(docs) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt deleted file mode 100644 index c63d6dc18..000000000 --- a/docs/CMakeLists.txt +++ /dev/null @@ -1,27 +0,0 @@ -IF( WANT_DOCS ) - # Builds the documentation. - FIND_PACKAGE( Sphinx REQUIRED ) - FIND_PACKAGE( Doxygen REQUIRED ) - - SET( SPHINX_SOURCE_DIR ${CMAKE_SOURCE_DIR}/docs/sphinx ) - SET( DOCUMENTATION_DIR ${OpenMW_BINARY_DIR}/docs ) - - FILE(MAKE_DIRECTORY ${DOCUMENTATION_DIR}/_static) - FILE(MAKE_DIRECTORY ${DOCUMENTATION_DIR}/_templates) - - CONFIGURE_FILE( - ${SPHINX_SOURCE_DIR}/source/conf.py.in - ${DOCUMENTATION_DIR}/conf.py - @ONLY) - - CONFIGURE_FILE( - ${SPHINX_SOURCE_DIR}/run_sphinx_build.sh.in - ${DOCUMENTATION_DIR}/run_sphinx_build.sh - @ONLY) - - IF(UNIX) - EXECUTE_PROCESS(COMMAND chmod +x ${DOCUMENTATION_DIR}/run_sphinx_build.sh OUTPUT_QUIET) - EXECUTE_PROCESS(COMMAND ${DOCUMENTATION_DIR}/run_sphinx_build.sh OUTPUT_QUIET) - ENDIF(UNIX) - -ENDIF() diff --git a/docs/cs-manual/Makefile b/docs/cs-manual/Makefile deleted file mode 100644 index 9d62dc5ab..000000000 --- a/docs/cs-manual/Makefile +++ /dev/null @@ -1,216 +0,0 @@ -# Makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -PAPER = -BUILDDIR = build - -# User-friendly check for sphinx-build -ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) -$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) -endif - -# Internal variables. -PAPEROPT_a4 = -D latex_paper_size=a4 -PAPEROPT_letter = -D latex_paper_size=letter -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source -# the i18n builder cannot share the environment and doctrees with the others -I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source - -.PHONY: help -help: - @echo "Please use \`make ' where is one of" - @echo " html to make standalone HTML files" - @echo " dirhtml to make HTML files named index.html in directories" - @echo " singlehtml to make a single large HTML file" - @echo " pickle to make pickle files" - @echo " json to make JSON files" - @echo " htmlhelp to make HTML files and a HTML help project" - @echo " qthelp to make HTML files and a qthelp project" - @echo " applehelp to make an Apple Help Book" - @echo " devhelp to make HTML files and a Devhelp project" - @echo " epub to make an epub" - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" - @echo " latexpdf to make LaTeX files and run them through pdflatex" - @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" - @echo " text to make text files" - @echo " man to make manual pages" - @echo " texinfo to make Texinfo files" - @echo " info to make Texinfo files and run them through makeinfo" - @echo " gettext to make PO message catalogs" - @echo " changes to make an overview of all changed/added/deprecated items" - @echo " xml to make Docutils-native XML files" - @echo " pseudoxml to make pseudoxml-XML files for display purposes" - @echo " linkcheck to check all external links for integrity" - @echo " doctest to run all doctests embedded in the documentation (if enabled)" - @echo " coverage to run coverage check of the documentation (if enabled)" - -.PHONY: clean -clean: - rm -rf $(BUILDDIR)/* - -.PHONY: html -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." - -.PHONY: dirhtml -dirhtml: - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." - -.PHONY: singlehtml -singlehtml: - $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml - @echo - @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." - -.PHONY: pickle -pickle: - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle - @echo - @echo "Build finished; now you can process the pickle files." - -.PHONY: json -json: - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json - @echo - @echo "Build finished; now you can process the JSON files." - -.PHONY: htmlhelp -htmlhelp: - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp - @echo - @echo "Build finished; now you can run HTML Help Workshop with the" \ - ".hhp project file in $(BUILDDIR)/htmlhelp." - -.PHONY: qthelp -qthelp: - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp - @echo - @echo "Build finished; now you can run "qcollectiongenerator" with the" \ - ".qhcp project file in $(BUILDDIR)/qthelp, like this:" - @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenMWCSManual.qhcp" - @echo "To view the help file:" - @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenMWCSManual.qhc" - -.PHONY: applehelp -applehelp: - $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp - @echo - @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." - @echo "N.B. You won't be able to view it unless you put it in" \ - "~/Library/Documentation/Help or install it in your application" \ - "bundle." - -.PHONY: devhelp -devhelp: - $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp - @echo - @echo "Build finished." - @echo "To view the help file:" - @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenMWCSManual" - @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenMWCSManual" - @echo "# devhelp" - -.PHONY: epub -epub: - $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub - @echo - @echo "Build finished. The epub file is in $(BUILDDIR)/epub." - -.PHONY: latex -latex: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo - @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." - @echo "Run \`make' in that directory to run these through (pdf)latex" \ - "(use \`make latexpdf' here to do that automatically)." - -.PHONY: latexpdf -latexpdf: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through pdflatex..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: latexpdfja -latexpdfja: - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex - @echo "Running LaTeX files through platex and dvipdfmx..." - $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja - @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." - -.PHONY: text -text: - $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text - @echo - @echo "Build finished. The text files are in $(BUILDDIR)/text." - -.PHONY: man -man: - $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man - @echo - @echo "Build finished. The manual pages are in $(BUILDDIR)/man." - -.PHONY: texinfo -texinfo: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo - @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." - @echo "Run \`make' in that directory to run these through makeinfo" \ - "(use \`make info' here to do that automatically)." - -.PHONY: info -info: - $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo - @echo "Running Texinfo files through makeinfo..." - make -C $(BUILDDIR)/texinfo info - @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." - -.PHONY: gettext -gettext: - $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale - @echo - @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." - -.PHONY: changes -changes: - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes - @echo - @echo "The overview file is in $(BUILDDIR)/changes." - -.PHONY: linkcheck -linkcheck: - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck - @echo - @echo "Link check complete; look for any errors in the above output " \ - "or in $(BUILDDIR)/linkcheck/output.txt." - -.PHONY: doctest -doctest: - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest - @echo "Testing of doctests in the sources finished, look at the " \ - "results in $(BUILDDIR)/doctest/output.txt." - -.PHONY: coverage -coverage: - $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage - @echo "Testing of coverage in the sources finished, look at the " \ - "results in $(BUILDDIR)/coverage/python.txt." - -.PHONY: xml -xml: - $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml - @echo - @echo "Build finished. The XML files are in $(BUILDDIR)/xml." - -.PHONY: pseudoxml -pseudoxml: - $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml - @echo - @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/cs-manual/make.bat b/docs/cs-manual/make.bat deleted file mode 100644 index 744d60007..000000000 --- a/docs/cs-manual/make.bat +++ /dev/null @@ -1,263 +0,0 @@ -@ECHO OFF - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=build -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source -set I18NSPHINXOPTS=%SPHINXOPTS% source -if NOT "%PAPER%" == "" ( - set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% - set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% -) - -if "%1" == "" goto help - -if "%1" == "help" ( - :help - echo.Please use `make ^` where ^ is one of - echo. html to make standalone HTML files - echo. dirhtml to make HTML files named index.html in directories - echo. singlehtml to make a single large HTML file - echo. pickle to make pickle files - echo. json to make JSON files - echo. htmlhelp to make HTML files and a HTML help project - echo. qthelp to make HTML files and a qthelp project - echo. devhelp to make HTML files and a Devhelp project - echo. epub to make an epub - echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter - echo. text to make text files - echo. man to make manual pages - echo. texinfo to make Texinfo files - echo. gettext to make PO message catalogs - echo. changes to make an overview over all changed/added/deprecated items - echo. xml to make Docutils-native XML files - echo. pseudoxml to make pseudoxml-XML files for display purposes - echo. linkcheck to check all external links for integrity - echo. doctest to run all doctests embedded in the documentation if enabled - echo. coverage to run coverage check of the documentation if enabled - goto end -) - -if "%1" == "clean" ( - for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i - del /q /s %BUILDDIR%\* - goto end -) - - -REM Check if sphinx-build is available and fallback to Python version if any -%SPHINXBUILD% 1>NUL 2>NUL -if errorlevel 9009 goto sphinx_python -goto sphinx_ok - -:sphinx_python - -set SPHINXBUILD=python -m sphinx.__init__ -%SPHINXBUILD% 2> nul -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -:sphinx_ok - - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/html. - goto end -) - -if "%1" == "dirhtml" ( - %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. - goto end -) - -if "%1" == "singlehtml" ( - %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. - goto end -) - -if "%1" == "pickle" ( - %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the pickle files. - goto end -) - -if "%1" == "json" ( - %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can process the JSON files. - goto end -) - -if "%1" == "htmlhelp" ( - %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run HTML Help Workshop with the ^ -.hhp project file in %BUILDDIR%/htmlhelp. - goto end -) - -if "%1" == "qthelp" ( - %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; now you can run "qcollectiongenerator" with the ^ -.qhcp project file in %BUILDDIR%/qthelp, like this: - echo.^> qcollectiongenerator %BUILDDIR%\qthelp\OpenMWCSManual.qhcp - echo.To view the help file: - echo.^> assistant -collectionFile %BUILDDIR%\qthelp\OpenMWCSManual.ghc - goto end -) - -if "%1" == "devhelp" ( - %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. - goto end -) - -if "%1" == "epub" ( - %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The epub file is in %BUILDDIR%/epub. - goto end -) - -if "%1" == "latex" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - if errorlevel 1 exit /b 1 - echo. - echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdf" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "latexpdfja" ( - %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex - cd %BUILDDIR%/latex - make all-pdf-ja - cd %~dp0 - echo. - echo.Build finished; the PDF files are in %BUILDDIR%/latex. - goto end -) - -if "%1" == "text" ( - %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The text files are in %BUILDDIR%/text. - goto end -) - -if "%1" == "man" ( - %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The manual pages are in %BUILDDIR%/man. - goto end -) - -if "%1" == "texinfo" ( - %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. - goto end -) - -if "%1" == "gettext" ( - %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The message catalogs are in %BUILDDIR%/locale. - goto end -) - -if "%1" == "changes" ( - %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes - if errorlevel 1 exit /b 1 - echo. - echo.The overview file is in %BUILDDIR%/changes. - goto end -) - -if "%1" == "linkcheck" ( - %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck - if errorlevel 1 exit /b 1 - echo. - echo.Link check complete; look for any errors in the above output ^ -or in %BUILDDIR%/linkcheck/output.txt. - goto end -) - -if "%1" == "doctest" ( - %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest - if errorlevel 1 exit /b 1 - echo. - echo.Testing of doctests in the sources finished, look at the ^ -results in %BUILDDIR%/doctest/output.txt. - goto end -) - -if "%1" == "coverage" ( - %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage - if errorlevel 1 exit /b 1 - echo. - echo.Testing of coverage in the sources finished, look at the ^ -results in %BUILDDIR%/coverage/python.txt. - goto end -) - -if "%1" == "xml" ( - %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The XML files are in %BUILDDIR%/xml. - goto end -) - -if "%1" == "pseudoxml" ( - %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml - if errorlevel 1 exit /b 1 - echo. - echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. - goto end -) - -:end diff --git a/docs/cs-manual/source/conf.py b/docs/cs-manual/source/conf.py deleted file mode 100644 index 28931a4a0..000000000 --- a/docs/cs-manual/source/conf.py +++ /dev/null @@ -1,358 +0,0 @@ -# -*- coding: utf-8 -*- -# -# OpenMW CS Manual documentation build configuration file, created by -# sphinx-quickstart on Fri Feb 5 21:28:27 2016. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys -import os - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -#sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# source_suffix = ['.rst', '.md'] -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'OpenMW CS Manual' -copyright = u'2016, The OpenMW Project' -author = u'HiPhish' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = u'0.0' -# The full version, including alpha/beta/rc tags. -release = u'0.0' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = [] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -#modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'alabaster' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -#html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# 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'] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -#html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -#html_domain_indices = True - -# If false, no index is generated. -#html_use_index = True - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, links to the reST sources are added to the pages. -#html_show_sourcelink = True - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -#html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = None - -# Language to be used for generating the HTML full-text search index. -# Sphinx supports the following languages: -# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' -# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' -#html_search_language = 'en' - -# A dictionary with options for the search language support, empty by default. -# Now only 'ja' uses this config value -#html_search_options = {'type': 'default'} - -# The name of a javascript file (relative to the configuration directory) that -# implements a search results scorer. If empty, the default will be used. -#html_search_scorer = 'scorer.js' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'OpenMWCSManualdoc' - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { -# The paper size ('letterpaper' or 'a4paper'). -#'papersize': 'letterpaper', - -# The font size ('10pt', '11pt' or '12pt'). -#'pointsize': '10pt', - -# Additional stuff for the LaTeX preamble. -#'preamble': '', - -# Latex figure (float) alignment -#'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, 'OpenMWCSManual.tex', u'OpenMW CS Manual Documentation', - u'HiPhish', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# If true, show page references after internal links. -#latex_show_pagerefs = False - -# If true, show URL addresses after external links. -#latex_show_urls = False - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -#latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - (master_doc, 'openmwcsmanual', u'OpenMW CS Manual Documentation', - [author], 1) -] - -# If true, show URL addresses after external links. -#man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - (master_doc, 'OpenMWCSManual', u'OpenMW CS Manual Documentation', - author, 'OpenMWCSManual', 'One line description of project.', - 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -#texinfo_appendices = [] - -# If false, no module index is generated. -#texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False - - -# -- Options for Epub output ---------------------------------------------- - -# Bibliographic Dublin Core info. -epub_title = project -epub_author = author -epub_publisher = author -epub_copyright = copyright - -# The basename for the epub file. It defaults to the project name. -#epub_basename = project - -# The HTML theme for the epub output. Since the default themes are not -# optimized for small screen space, using the same theme for HTML and epub -# output is usually not wise. This defaults to 'epub', a theme designed to save -# visual space. -#epub_theme = 'epub' - -# The language of the text. It defaults to the language option -# or 'en' if the language is not set. -#epub_language = '' - -# The scheme of the identifier. Typical schemes are ISBN or URL. -#epub_scheme = '' - -# The unique identifier of the text. This can be a ISBN number -# or the project homepage. -#epub_identifier = '' - -# A unique identification for the text. -#epub_uid = '' - -# A tuple containing the cover image and cover page html template filenames. -#epub_cover = () - -# A sequence of (type, uri, title) tuples for the guide element of content.opf. -#epub_guide = () - -# HTML files that should be inserted before the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_pre_files = [] - -# HTML files that should be inserted after the pages created by sphinx. -# The format is a list of tuples containing the path and title. -#epub_post_files = [] - -# A list of files that should not be packed into the epub file. -epub_exclude_files = ['search.html'] - -# The depth of the table of contents in toc.ncx. -#epub_tocdepth = 3 - -# Allow duplicate toc entries. -#epub_tocdup = True - -# Choose between 'default' and 'includehidden'. -#epub_tocscope = 'default' - -# Fix unsupported image types using the Pillow. -#epub_fix_images = False - -# Scale large images. -#epub_max_image_width = 0 - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -#epub_show_urls = 'inline' - -# If false, no index is generated. -#epub_use_index = True - - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 000000000..6ee8d6987 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +breathe +parse_cmake +sphinx diff --git a/docs/sphinx/source/conf.py.in b/docs/source/conf.py similarity index 94% rename from docs/sphinx/source/conf.py.in rename to docs/source/conf.py index 218ef8b6d..12c6f91a7 100644 --- a/docs/sphinx/source/conf.py.in +++ b/docs/source/conf.py @@ -18,7 +18,8 @@ import os # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('@CMAKE_SOURCE_DIR@')) +project_root = os.path.abspath('../../') +sys.path.insert(0, project_root) # -- General configuration ------------------------------------------------ @@ -39,7 +40,7 @@ extensions = [ # Where breathe can find the source files breathe_projects_source = { - "openmw": ("@CMAKE_SOURCE_DIR@/apps/openmw", ["engine.hpp", + "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", @@ -62,18 +63,22 @@ master_doc = 'index' project = u'OpenMW' copyright = u'2016, OpenMW Team' + # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '@OPENMW_VERSION@' # The full version, including alpha/beta/rc tags. -release = '@OPENMW_VERSION@' + +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) # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +#language = cpp # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -144,7 +149,9 @@ html_theme = 'default' # Add any paths that contain custom static files (such as style sheets) here, # 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'] +html_static_path = ['_static', + 'openmw-cs/_static' + ] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied diff --git a/docs/sphinx/source/index.rst b/docs/source/index.rst similarity index 77% rename from docs/sphinx/source/index.rst rename to docs/source/index.rst index 64c3c9796..32844146c 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/source/index.rst @@ -6,9 +6,10 @@ Components ---------- .. toctree:: - :maxdepth: 2 - - openmw + :maxdepth: 2 + + openmw/index + openmw-cs/index Indices and tables diff --git a/docs/cs-manual/source/_static/images/chapter-1/add-record.png b/docs/source/openmw-cs/_static/images/chapter-1/add-record.png similarity index 100% rename from docs/cs-manual/source/_static/images/chapter-1/add-record.png rename to docs/source/openmw-cs/_static/images/chapter-1/add-record.png diff --git a/docs/cs-manual/source/_static/images/chapter-1/edit-record.png b/docs/source/openmw-cs/_static/images/chapter-1/edit-record.png similarity index 100% rename from docs/cs-manual/source/_static/images/chapter-1/edit-record.png rename to docs/source/openmw-cs/_static/images/chapter-1/edit-record.png diff --git a/docs/cs-manual/source/_static/images/chapter-1/new-project.png b/docs/source/openmw-cs/_static/images/chapter-1/new-project.png similarity index 100% rename from docs/cs-manual/source/_static/images/chapter-1/new-project.png rename to docs/source/openmw-cs/_static/images/chapter-1/new-project.png diff --git a/docs/cs-manual/source/_static/images/chapter-1/objects.png b/docs/source/openmw-cs/_static/images/chapter-1/objects.png similarity index 100% rename from docs/cs-manual/source/_static/images/chapter-1/objects.png rename to docs/source/openmw-cs/_static/images/chapter-1/objects.png diff --git a/docs/cs-manual/source/_static/images/chapter-1/opening-dialogue.png b/docs/source/openmw-cs/_static/images/chapter-1/opening-dialogue.png similarity index 100% rename from docs/cs-manual/source/_static/images/chapter-1/opening-dialogue.png rename to docs/source/openmw-cs/_static/images/chapter-1/opening-dialogue.png diff --git a/docs/cs-manual/source/files-and-directories.rst b/docs/source/openmw-cs/files-and-directories.rst similarity index 100% rename from docs/cs-manual/source/files-and-directories.rst rename to docs/source/openmw-cs/files-and-directories.rst diff --git a/docs/cs-manual/source/foreword.rst b/docs/source/openmw-cs/foreword.rst similarity index 100% rename from docs/cs-manual/source/foreword.rst rename to docs/source/openmw-cs/foreword.rst diff --git a/docs/cs-manual/source/index.rst b/docs/source/openmw-cs/index.rst similarity index 78% rename from docs/cs-manual/source/index.rst rename to docs/source/openmw-cs/index.rst index ce50b8c95..dcd28081a 100644 --- a/docs/cs-manual/source/index.rst +++ b/docs/source/openmw-cs/index.rst @@ -1,8 +1,3 @@ -.. OpenMW CS Manual documentation master file, created by - sphinx-quickstart on Fri Feb 5 21:28:27 2016. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - ##################### OpenMW CS user manual ##################### diff --git a/docs/cs-manual/source/starting-dialog.rst b/docs/source/openmw-cs/starting-dialog.rst similarity index 100% rename from docs/cs-manual/source/starting-dialog.rst rename to docs/source/openmw-cs/starting-dialog.rst diff --git a/docs/cs-manual/source/tour.rst b/docs/source/openmw-cs/tour.rst similarity index 97% rename from docs/cs-manual/source/tour.rst rename to docs/source/openmw-cs/tour.rst index 0e92fe6fa..3ddeac4fa 100644 --- a/docs/cs-manual/source/tour.rst +++ b/docs/source/openmw-cs/tour.rst @@ -24,7 +24,7 @@ We will start by launching OpenMW CS, the location of the program depends on your operating system. You will be presented with a dialogue with three options: create a new game, create a new addon, edit a content file. -.. figure:: ./_static/images/chapter-1/opening-dialogue.png +.. figure:: _static/images/chapter-1/opening-dialogue.png :alt: Opening dialogue with three option and setting button (the wrench) The first option is for creating an entirely new game, that's not what we want. @@ -37,7 +37,7 @@ optionally a number of other addons we want to depend on. The name of the project is arbitrary, it will be used to identify the addon later in the OpenMW launcher. -.. figure:: ./_static/images/chapter-1/new-project.png +.. figure:: _static/images/chapter-1/new-project.png :alt: Creation dialogue for a new project, pick content modules and name Choose Morrowind as your content file and enter `Ring of Night Vision` as the @@ -47,7 +47,7 @@ to, but for this mod the base game is enough. Once the addon has been created you will be presented with a table. If you see a blank window rather than a table choose *World* → *Objects* from the menu. -.. figure:: ./_static/images/chapter-1/objects.png +.. figure:: _static/images/chapter-1/objects.png :alt: The table showing all objet records in the game. Let's talk about the interface for a second. Every window in OpenMW CS has @@ -83,7 +83,7 @@ We need to enter an *ID* (short for *identifier*) and pick the type. The identifier is a unique name by which the ring can later be identified; I have chosen `ring_night_vision`. For the type choose *Clothing*. -.. figure:: ./_static/images/chapter-1/add-record.png +.. figure:: _static/images/chapter-1/add-record.png :alt: Enter the ID and type of the new ring The table should jump right to our newly created record, if not read further @@ -101,7 +101,7 @@ instead of using the context menu; the default is double-clicking while holding down the shift key. -.. figure:: ./_static/images/chapter-1/edit-record.png +.. figure:: _static/images/chapter-1/edit-record.png :alt: Edit the properties of the record in a separate panel You can set the name, weight and coin value as you like, I chose `Ring of Night diff --git a/docs/sphinx/source/openmw.rst b/docs/source/openmw/index.rst similarity index 66% rename from docs/sphinx/source/openmw.rst rename to docs/source/openmw/index.rst index 2da7caa5f..ce4e42f1f 100644 --- a/docs/sphinx/source/openmw.rst +++ b/docs/source/openmw/index.rst @@ -1,5 +1,6 @@ -openmw -====== +########################### +OpenMW Source Documentation +########################### .. toctree:: :maxdepth: 2 diff --git a/docs/sphinx/source/mwbase.rst b/docs/source/openmw/mwbase.rst similarity index 95% rename from docs/sphinx/source/mwbase.rst rename to docs/source/openmw/mwbase.rst index 4044fbc97..182ed66f6 100644 --- a/docs/sphinx/source/mwbase.rst +++ b/docs/source/openmw/mwbase.rst @@ -1,5 +1,6 @@ -openmw/mwbase -============= +######## +./mwbase +######## .. autodoxygenfile:: mwbase/dialoguemanager.hpp :project: openmw diff --git a/docs/sphinx/run_sphinx_build.sh.in b/docs/sphinx/run_sphinx_build.sh.in deleted file mode 100644 index ddd4dc2bb..000000000 --- a/docs/sphinx/run_sphinx_build.sh.in +++ /dev/null @@ -1,7 +0,0 @@ -#!/bin/bash -echo "Creating Sphinx documentation in: @SPHINX_DESTINATION@" - -LD_LIBRARY_PATH="@CMAKE_INSTALL_PREFIX@/lib:$LD_LIBRARY_PATH" - -@SPHINX_EXECUTABLE@ -b html -c @CMAKE_CURRENT_BINARY_DIR@/ @SPHINX_SOURCE_DIR@/source @DOCUMENTATION_DIR@/html -@SPHINX_EXECUTABLE@ -b man -c @CMAKE_CURRENT_BINARY_DIR@/ @SPHINX_SOURCE_DIR@/source @DOCUMENTATION_DIR@/man \ No newline at end of file