Skip to content

Commit

Permalink
[skip ci] Starting to update documentation.
Browse files Browse the repository at this point in the history
Switch to the absolutely wonderful "guzzle" theme for sphinx. Deleted
the old custom theme.

Starting move to the newer syntax used by sphinx for c++ template
classes.

Resolve a few formatting issues.

Starting to update mentions of the never release 1.2 to the upcoming 2.0
release.
  • Loading branch information
bruxisma committed Dec 1, 2016
1 parent ebdbf20 commit 8931fe5
Show file tree
Hide file tree
Showing 9 changed files with 148 additions and 220 deletions.
12 changes: 6 additions & 6 deletions Readme.rst
Expand Up @@ -13,10 +13,10 @@ Build scripts provided by MNMLSTC Core are released under the CC0 1.0 Universal
License.

.. image:: https://travis-ci.org/mnmlstc/core.svg
:target: https://travis-ci.org/mnmlstc/core
:target: https://travis-ci.org/mnmlstc/core

.. image:: https://codecov.io/gh/mnmlstc/core/branch/master/graph/badge.svg
:target: https://codecov.io/gh/mnmlstc/core
:target: https://codecov.io/gh/mnmlstc/core

Components
----------
Expand Down Expand Up @@ -46,13 +46,13 @@ There are several requirements to fully use MNMLSTC Core:
set required to build and use MNMLSTC Core)
* `CMake 3.0.0 <http://cmake.org>`_

Additionally, to actively develop MNMLSTC Core, the following are required:
Additionally, to develop or package MNMLSTC Core, the following are required:

* `Sphinx Documentation Generator <http://sphinx-doc.org>`_
* `Alabaster Sphinx Theme <https://github.com/bitprophet/alabaster>`_
* `Guzzle Sphinx Theme <https://github.com/guzzle/guzzle_sphinx_theme>`_
* `WiX Toolset <http://wixtoolset.org>`_

Sphinx and the Alabaster Sphinx Theme are only necessary if generating
documentation manually.
Sphinx and the Guzzle Sphinx Theme are only necessary if generating
documentation manually to be included with the package.

WiX Toolset is only required if building packages for Windows.
16 changes: 7 additions & 9 deletions docs/conf.py
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
import alabaster as theme
import guzzle_sphinx_theme
import os

project = 'MNMLSTC Core'
Expand All @@ -10,20 +10,18 @@

needs_sphinx = '1.3'

html_static_path = ['static']
html_theme_path = [theme.get_path()]
html_theme = 'alabaster'
html_theme_options = { 'show_powered_by' : False }
html_style = 'theme.css'
html_sidebars = { '**' : ['navigation.html'] }
html_translate_class = 'guzzle_sphinx_theme.HTMLTranslator'
html_theme_path = guzzle_sphinx_theme.html_theme_path()
html_theme = 'guzzle_sphinx_theme'
html_theme_options = dict(project_nav_name='MNMLSTC Core')

highlight_language = 'cpp'
primary_domain = 'cpp'

pygments_style = 'manni'

exclude_patterns = ['_build']
templates_path = ['templates']
#templates_path = ['templates']
source_suffix = '.rst'
master_doc = 'index'

Expand All @@ -36,6 +34,6 @@
'''

extensions = ['sphinx.ext.todo', 'alabaster']
extensions = ['sphinx.ext.todo']#, 'guzzle_sphinx_theme']

todo_include_todos = True

0 comments on commit 8931fe5

Please sign in to comment.