Update documentation.

tatsy · Jul 15, 2018 · 1d2d90b · 1d2d90b
1 parent 9b7d9d0
commit 1d2d90b
Show file tree

Hide file tree

Showing 7 changed files with 64 additions and 71 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,6 @@
 # Common ignore files
 build/*
+docs/build/*
 tests/data/tmp
 .cccc
 test_params.h

diff --git a/docs/deploy.sh b/docs/deploy.sh
@@ -15,10 +15,12 @@ git config --global user.email "travis@travis-ci.org"
 #
 ## Run Doxygen and Sphinx docs
 #
+rm -rf html/*
+
 doxygen doxyfile
 make html
-rm -rf html/*
-cp -R build/html/* html
+mv build/html html
+mv classref html/reference
 
 #
 ## Deploy GitHub pages

diff --git a/docs/doxyfile b/docs/doxyfile
@@ -765,7 +765,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = ../src ../include
+INPUT                  = ../sources
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -805,7 +805,7 @@ RECURSIVE              = YES
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                =
+EXCLUDE                = ../sources/submodules
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -906,7 +906,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-INPUT                 =
+USE_MDFILE_AS_MAINPAGE =
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing
@@ -1046,15 +1046,15 @@ IGNORE_PREFIX          =
 # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
 # The default value is: YES.
 
-GENERATE_HTML          = NO
+GENERATE_HTML          = YES
 
 # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
 # it.
 # The default directory is: html.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_OUTPUT            = html
+HTML_OUTPUT            = classref
 
 # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
 # generated HTML page (for example: .htm, .php, .asp).

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -58,17 +58,17 @@
 
 # General information about the project.
 project = 'spica'
-copyright = 'MIT License 2015-2016, Tatsuya Yatagawa (tatsy)'
+copyright = 'MIT License 2015-2018, Tatsuya Yatagawa (tatsy)'
 author = 'tatsy'
 
 # 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 = 'v1.3.1'
+version = 'v1.3.0'
 # The full version, including alpha/beta/rc tags.
-release = 'v1.3.1'
+release = 'v1.3.0'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,20 +6,64 @@
 Welcome to spica's documentation!
 =================================
 
-``spica`` is a cross-platform physically based rendering engine.
+The project **spica** is for a cross-platform physically based rendering engine.
+This program employs a plug-in system and is easy-to-build for the user convenience!
 
-Contents:
+Installation
+************
 
-.. toctree::
-   :maxdepth: 1
+Requirements
+------------
 
-   install
-   reference/index
+The project is implemented and tested with the following compilers that supports C++17.
 
+* GNU C++ compiler (v7.3.0 or higher)
+* Microsoft Visual C++ compiler (MSVC 2017)
+
+I confirmed the programs can be build on the following environments. The build will be successful also on other environments if you compile them with the compilers above.
+
+* Windows 10 64bit
+* MacOS X High Sierra
+* Ubuntu 16.04 LTS
+
+Dependencies
+------------
+
+All the dependencies are included by Git's submodule system (and they can be immediately installed!).
+
+Build command
+-------------
+
+You can build the programs with **CMake** (v3.6.0 or higher). For UNIX users, the following command will build them.
+
+.. code-block:: shell
+
+  $ git clone --depth=10 https://github.com/tatsy.spica.git
+  $ cd spica && mkdir build && cd build
+  $ cmake -D CMAKE_BUILD_TYPE=Release -D SPICA_BUILD_MAIN=ON [-D WITH_SSE=ON] ..
+  $ make -j4
+  $ make install  # No sudo required!
+
+Usage
+*****
+
+Executable binary **spica** is made by the build typically in ``build/bin``. In this directory, run **spica** as the following command.
+
+.. code-block:: shell
+
+  $ ./spica --input INPUT XML [--threads NUM_THREADS]
+
+You can find sample scene files (written with XML) in `GitHub <https://github.com/tatsy/spica/blob/master/scenes/README.md>`_.
+The scene files can be written as that of `Mitsuba renderer <https://www.mitsuba-renderer.org/>`_ (but only selected functions are supported).
+
+Other resources
+***************
+
+* `Class reference <./reference/index.html>`_
 
 
 Indices and tables
-==================
+******************
 
 * :ref:`genindex`
 * :ref:`modindex`

diff --git a/docs/source/install.rst b/docs/source/install.rst
diff --git a/docs/source/reference/index.rst b/docs/source/reference/index.rst