Commit a541babf authored by Spencer Williams's avatar Spencer Williams
Browse files

add example doc to test the theme before dist

parent fad8a93c
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = SphinxExample
SOURCEDIR = source
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
set SPHINXPROJ=SphinxExample
if "%1" == "" goto help
%SPHINXBUILD% >NUL 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
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
:end
popd
../../../theme/sphinx_rigado_theme/
\ No newline at end of file
# -*- coding: utf-8 -*-
#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
# full list see the documentation:
# http://www.sphinx-doc.org/en/stable/config
# -- Path setup --------------------------------------------------------------
# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Sphinx Example'
copyright = '2018, Spencer Williams'
author = 'Spencer Williams'
# The short X.Y version
version = ''
# The full version, including alpha/beta/rc tags
release = ''
# -- General configuration ---------------------------------------------------
extensions = [
]
templates_path = ['_templates']
source_suffix = '.rst'
master_doc = 'index'
language = None
exclude_patterns = []
pygments_style = 'sphinx'
# -- Options for HTML output -------------------------------------------------
html_theme_path = ['_themes']
html_theme = 'sphinx_rigado_theme'
html_static_path = ['_static']
html_sidebars = {
'**': ['searchbar.html',
'globaltoc.html',
'localtoc.html',
'relations.html',
'sourcelink.html']
}
# -- 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, 'SphinxExample.tex', 'Sphinx Example Documentation',
'Spencer Williams', 'manual'),
]
.. Sphinx Example documentation master file, created by
sphinx-quickstart on Tue Jun 5 15:16:41 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Sphinx Example's documentation!
==========================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
......@@ -17,6 +17,7 @@
{%- block extrahead %}
<meta name="google" value="notranslate">
<link rel="shortcut icon" href="{{ pathto('_static/images/R 32x32.ico', 1) }}"/>
{% endblock %}
{# remove breadcrumbs from relbar, add logo to relbar #}
......@@ -32,7 +33,7 @@
{{ reldelim2 }}</li>
{%- endfor %}
<li class="nav-item nav-item-0">
<a href="/"><img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="{{ shorttitle|e }}"/></a>
<a href="/"><img class="logo" src="{{ pathto('_static/images/RigadoFullColor-800px.png', 1) }}" alt="{{ shorttitle|e }}"/></a>
</li>
</ul>
</div>
......@@ -66,6 +67,17 @@
{%- include "sourcelink.html" %}
{%- endblock %}
{%- endif %}
{% if theme_display_version %}
{%- set nav_version = version %}
{% if READTHEDOCS and current_version %}
{%- set nav_version = current_version %}
{% endif %}
{% if nav_version %}
<div class="version">
{{ nav_version }}
</div>
{% endif %}
{% endif %}
</div>
</div>
{%- endif %}
......
......@@ -7,4 +7,27 @@ pygments_style = none
analytics_ua =
analytics_domain =
use_search = True
use_global_toc =
use_global_toc = True
display_version = True
footerbgcolor = #ffffff
footertextcolor = #1d1d1d
sidebarbgcolor = #ffffff
sidebarbtncolor = #fafafa
sidebartextcolor = #1d1d1d
sidebarlinkcolor = #1f5b8d
relbarbgcolor = #fafafa
relbartextcolor = #1f5b8d
relbarlinkcolor = #1f5b8d
bgcolor = #ffffff
textcolor = #1d1d1d
headbgcolor = #ffffff
headtextcolor = #1d1d1d
headlinkcolor = #1f5b8d
linkcolor = #1f5b8d
visitedlinkcolor = #1f5b8d
codebgcolor = #fafafa
codetextcolor = #1d1d1d
bodyfont = "Source Sans Pro", Helvetica, Arial, sans-serif
headfont = "Source Sans Pro", Helvetica, Arial, sans-serif
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment