mirror of
https://github.com/ThePhD/sol2.git
synced 2024-03-22 13:10:44 +08:00
first pass breakpoint
This commit is contained in:
parent
8bb2a55146
commit
97152e74c5
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,6 +1,6 @@
|
||||||
*.pyc
|
*.pyc
|
||||||
*.egg-info
|
*.egg-info
|
||||||
build/
|
*build/
|
||||||
dist/
|
dist/
|
||||||
.tox
|
.tox
|
||||||
.coverage
|
.coverage
|
||||||
|
|
70
Gruntfile.js
70
Gruntfile.js
|
@ -4,45 +4,91 @@ module.exports = function(grunt) {
|
||||||
require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
|
require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);
|
||||||
|
|
||||||
grunt.initConfig({
|
grunt.initConfig({
|
||||||
|
|
||||||
compass: {
|
connect: {
|
||||||
dev: {
|
server: {
|
||||||
options: {
|
options: {
|
||||||
config: 'sphinx_rtd_theme/sass/config.rb',
|
port: 9000,
|
||||||
basePath: 'sphinx_rtd_theme/sass',
|
base: 'demo_docs/build/html'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
|
||||||
|
compass: {
|
||||||
|
src: {
|
||||||
|
options: {
|
||||||
|
config: 'src/sphinx_rtd_theme/sass/config.rb',
|
||||||
|
basePath: 'src/sphinx_rtd_theme/sass',
|
||||||
|
force: true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
dist: {
|
||||||
|
options: {
|
||||||
|
config: 'src/sphinx_rtd_theme/sass/config.rb',
|
||||||
|
basePath: 'src/sphinx_rtd_theme/sass',
|
||||||
outputStyle: 'compressed',
|
outputStyle: 'compressed',
|
||||||
force: true
|
force: true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
// I use this to build the sphinx_rtd_theme available at https://github.com/snide/sphinx_rtd_theme
|
// I use this to build the sphinx_rtd_theme available at https://github.com/snide/sphinx_rtd_theme
|
||||||
copy: {
|
copy: {
|
||||||
sphinx_rtd_theme : {
|
dist : {
|
||||||
files: [
|
files: [
|
||||||
{
|
{
|
||||||
expand: true,
|
expand: true,
|
||||||
cwd: 'docs/source/_themes/wyrm_theme',
|
cwd: 'src/sphinx_rtd_theme',
|
||||||
src: ['**', '!**/theme.sass', '!**/*.css', '!**/config.rb'],
|
src: ['**', '!sass/'],
|
||||||
dest: '../sphinx_rtd_theme/sphinx_rtd_theme'
|
dest: 'dist/sphinx_rtd_theme'
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
|
||||||
exec: {
|
exec: {
|
||||||
update: {
|
bower_update: {
|
||||||
cmd: 'bower update'
|
cmd: 'bower update'
|
||||||
|
},
|
||||||
|
build_sphinx: {
|
||||||
|
cmd: 'cd demo_docs && make html'
|
||||||
}
|
}
|
||||||
|
},
|
||||||
|
clean: {
|
||||||
|
src: ["demo_docs/build"],
|
||||||
|
dist: ["dist/sphinx_rtd_theme"]
|
||||||
|
},
|
||||||
|
|
||||||
|
watch: {
|
||||||
|
sass: {
|
||||||
|
files: ['src/sphinx_rtd_theme/*.sass', 'bower_components/**/*.sass'],
|
||||||
|
tasks: ['compass:src']
|
||||||
|
},
|
||||||
|
/* watch and see if our javascript files change, or new packages are installed */
|
||||||
|
sphinx_update: {
|
||||||
|
files: ['src/sphinx_rtd_theme/static/*.css', 'src/sphinx_rtd_theme/*.js', 'demo_docs/source/*.rst', 'src/sphinx_theme/*.html'],
|
||||||
|
tasks: ['clean:src','exec:build_sphinx']
|
||||||
|
},
|
||||||
|
/* watch our files for change, reload */
|
||||||
|
livereload: {
|
||||||
|
files: ['demo_docs/build/html/**/*.html', 'demo_docs/build/html/_static/*.css', 'demo_docs/build/html/_static/*.js'],
|
||||||
|
options: {
|
||||||
|
livereload: true
|
||||||
|
}
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
});
|
});
|
||||||
|
|
||||||
grunt.loadNpmTasks('grunt-contrib-copy');
|
grunt.loadNpmTasks('grunt-contrib-copy');
|
||||||
grunt.loadNpmTasks('grunt-exec');
|
grunt.loadNpmTasks('grunt-exec');
|
||||||
|
grunt.loadNpmTasks('grunt-contrib-connect');
|
||||||
|
grunt.loadNpmTasks('grunt-contrib-watch');
|
||||||
grunt.loadNpmTasks('grunt-contrib-compass');
|
grunt.loadNpmTasks('grunt-contrib-compass');
|
||||||
|
grunt.loadNpmTasks('grunt-contrib-clean');
|
||||||
|
|
||||||
grunt.registerTask('default', ['exec', 'compass']);
|
grunt.registerTask('default', ['bower_update','connect','watch']);
|
||||||
|
grunt.registerTask('build', ['clean:dist','compass:dist','copy:dist']);
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
153
demo_docs/Makefile
Normal file
153
demo_docs/Makefile
Normal file
|
@ -0,0 +1,153 @@
|
||||||
|
# Makefile for Sphinx documentation
|
||||||
|
#
|
||||||
|
|
||||||
|
# You can set these variables from the command line.
|
||||||
|
SPHINXOPTS =
|
||||||
|
SPHINXBUILD = sphinx-build
|
||||||
|
PAPER =
|
||||||
|
BUILDDIR = build
|
||||||
|
|
||||||
|
# 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 clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||||
|
|
||||||
|
help:
|
||||||
|
@echo "Please use \`make <target>' where <target> 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 " latexpdf to make LaTeX files and run them through pdflatex"
|
||||||
|
@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 " linkcheck to check all external links for integrity"
|
||||||
|
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||||
|
|
||||||
|
clean:
|
||||||
|
-rm -rf $(BUILDDIR)/*
|
||||||
|
|
||||||
|
html:
|
||||||
|
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||||
|
|
||||||
|
dirhtml:
|
||||||
|
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||||
|
|
||||||
|
singlehtml:
|
||||||
|
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||||
|
|
||||||
|
pickle:
|
||||||
|
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the pickle files."
|
||||||
|
|
||||||
|
json:
|
||||||
|
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||||
|
@echo
|
||||||
|
@echo "Build finished; now you can process the JSON files."
|
||||||
|
|
||||||
|
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."
|
||||||
|
|
||||||
|
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/SphinxRTDthemedemo.qhcp"
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/SphinxRTDthemedemo.qhc"
|
||||||
|
|
||||||
|
devhelp:
|
||||||
|
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||||
|
@echo
|
||||||
|
@echo "Build finished."
|
||||||
|
@echo "To view the help file:"
|
||||||
|
@echo "# mkdir -p $$HOME/.local/share/devhelp/SphinxRTDthemedemo"
|
||||||
|
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/SphinxRTDthemedemo"
|
||||||
|
@echo "# devhelp"
|
||||||
|
|
||||||
|
epub:
|
||||||
|
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||||
|
|
||||||
|
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)."
|
||||||
|
|
||||||
|
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."
|
||||||
|
|
||||||
|
text:
|
||||||
|
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||||
|
|
||||||
|
man:
|
||||||
|
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||||
|
|
||||||
|
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)."
|
||||||
|
|
||||||
|
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."
|
||||||
|
|
||||||
|
gettext:
|
||||||
|
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||||
|
@echo
|
||||||
|
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||||
|
|
||||||
|
changes:
|
||||||
|
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||||
|
@echo
|
||||||
|
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||||
|
|
||||||
|
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."
|
||||||
|
|
||||||
|
doctest:
|
||||||
|
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||||
|
@echo "Testing of doctests in the sources finished, look at the " \
|
||||||
|
"results in $(BUILDDIR)/doctest/output.txt."
|
242
demo_docs/source/conf.py
Normal file
242
demo_docs/source/conf.py
Normal file
|
@ -0,0 +1,242 @@
|
||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
#
|
||||||
|
# Sphinx RTD theme demo documentation build configuration file, created by
|
||||||
|
# sphinx-quickstart on Sun Nov 3 11:56:36 2013.
|
||||||
|
#
|
||||||
|
# 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, 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 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'Sphinx RTD theme demo'
|
||||||
|
copyright = u'2013, Dave Snider'
|
||||||
|
|
||||||
|
# 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 = '1'
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = '1'
|
||||||
|
|
||||||
|
# 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 = []
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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 = 'sphinx_rtd_theme'
|
||||||
|
|
||||||
|
# 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 = ["../../src/", ]
|
||||||
|
|
||||||
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
|
# "<project> v<release> 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']
|
||||||
|
|
||||||
|
# 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 <link> 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 = 'SphinxRTDthemedemodoc'
|
||||||
|
|
||||||
|
|
||||||
|
# -- 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]).
|
||||||
|
latex_documents = [
|
||||||
|
('index', 'SphinxRTDthemedemo.tex', u'Sphinx RTD theme demo Documentation',
|
||||||
|
u'Dave Snider', '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', 'sphinxrtdthemedemo', u'Sphinx RTD theme demo Documentation',
|
||||||
|
[u'Dave Snider'], 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', 'SphinxRTDthemedemo', u'Sphinx RTD theme demo Documentation',
|
||||||
|
u'Dave Snider', 'SphinxRTDthemedemo', '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'
|
22
demo_docs/source/index.rst
Normal file
22
demo_docs/source/index.rst
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
.. Sphinx RTD theme demo documentation master file, created by
|
||||||
|
sphinx-quickstart on Sun Nov 3 11:56:36 2013.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
Welcome to Sphinx RTD theme demo's documentation!
|
||||||
|
=================================================
|
||||||
|
|
||||||
|
Contents:
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
||||||
|
|
|
@ -1,9 +0,0 @@
|
||||||
// This file just generates the RTD badge for use on docs not using the RTD theme.
|
|
||||||
|
|
||||||
@import wyrm_core/wy_variables
|
|
||||||
@import bourbon
|
|
||||||
@import neat
|
|
||||||
@import wyrm_core/mixin
|
|
||||||
@import wyrm_core/grid_settings
|
|
||||||
@import badge_font_awesome_mini
|
|
||||||
@import badge
|
|
|
@ -1,57 +0,0 @@
|
||||||
@import wyrm_core/wy_variables
|
|
||||||
|
|
||||||
// bourbon framework installed from bower
|
|
||||||
@import bourbon
|
|
||||||
|
|
||||||
// Bourbon neat installed from bower, edit grid settings for media queries
|
|
||||||
@import wyrm_core/grid_settings
|
|
||||||
@import neat
|
|
||||||
|
|
||||||
// Custom reset
|
|
||||||
@import wyrm_core/reset
|
|
||||||
|
|
||||||
// Some compass libs on top of Bourbon
|
|
||||||
@import compass/typography/vertical_rhythm
|
|
||||||
@import compass/typography/text/ellipsis
|
|
||||||
|
|
||||||
// Basic defaults and mixins
|
|
||||||
@import wyrm_core/mixin
|
|
||||||
@import wyrm_core/font_awesome
|
|
||||||
|
|
||||||
// Wyrm core styles
|
|
||||||
@import wyrm_core/alert
|
|
||||||
// @import wyrm_core/autocomplete
|
|
||||||
@import wyrm_core/button
|
|
||||||
@import wyrm_core/dropdown
|
|
||||||
@import wyrm_core/form
|
|
||||||
@import wyrm_core/generic
|
|
||||||
@import wyrm_core/grid_layout
|
|
||||||
@import wyrm_core/spinner
|
|
||||||
@import wyrm_core/table
|
|
||||||
@import wyrm_core/type
|
|
||||||
|
|
||||||
// Cms
|
|
||||||
// @import wyrm_addons/cms/dashboard
|
|
||||||
// @import wyrm_addons/cms/layout
|
|
||||||
// @import wyrm_addons/cms/list_like_table
|
|
||||||
// @import wyrm_addons/cms/plugin_store
|
|
||||||
|
|
||||||
// Elements
|
|
||||||
// @import wyrm_addons/elements/modal
|
|
||||||
// @import wyrm_addons/elements/stars
|
|
||||||
@import wyrm_addons/elements/tooltip
|
|
||||||
|
|
||||||
// Redactor
|
|
||||||
// @import wyrm_addons/redactor/figures
|
|
||||||
// @import wyrm_addons/redactor/redactor
|
|
||||||
|
|
||||||
// Restructured text and Sphinx
|
|
||||||
@import wyrm_addons/rst/rst
|
|
||||||
@import wyrm_addons/rst/pygments
|
|
||||||
// @import wyrm_addons/rst/pygments_dark
|
|
||||||
@import wyrm_addons/rst/pygments_light
|
|
||||||
|
|
||||||
// Theme specific styles
|
|
||||||
@import breadcrumbs
|
|
||||||
@import nav
|
|
||||||
@import badge
|
|
|
@ -1,4 +1,4 @@
|
||||||
// SIMPLIFIED VERSION OF FONT AWESOME, FOUND HERE http://fortawesome.github.com/Font-Awesome/
|
// Slimmer version of FA for use on the badge_only.sass file.
|
||||||
|
|
||||||
+font-face(fontawesome-webfont, '#{$font-awesome-dir}fontawesome_webfont')
|
+font-face(fontawesome-webfont, '#{$font-awesome-dir}fontawesome_webfont')
|
||||||
|
|
132
src/sphinx_rtd_theme/sass/_theme_rst.sass
Normal file
132
src/sphinx_rtd_theme/sass/_theme_rst.sass
Normal file
|
@ -0,0 +1,132 @@
|
||||||
|
.rst-content
|
||||||
|
// sometimes people provide sizing in their rst, while will break the responsive layout
|
||||||
|
img
|
||||||
|
max-width: 100%
|
||||||
|
height: auto !important
|
||||||
|
.section > img
|
||||||
|
margin-bottom: $base-line-height
|
||||||
|
.note, .attention, .caution, .danger, .error, .hint, .important, .tip, .warning
|
||||||
|
@extend .wy-alert
|
||||||
|
p.last, p.first
|
||||||
|
margin-bottom: 0
|
||||||
|
.admonition-title
|
||||||
|
font-weight: bold
|
||||||
|
@extend .icon
|
||||||
|
@extend .icon-exclamation-sign
|
||||||
|
&:before
|
||||||
|
margin-right: 4px
|
||||||
|
.note
|
||||||
|
@extend .wy-alert.wy-alert-info
|
||||||
|
.hint, .tip, .important
|
||||||
|
@extend .wy-alert.wy-alert-info
|
||||||
|
.error, .danger
|
||||||
|
@extend .wy-alert.wy-alert-danger
|
||||||
|
.warning, .caution, .attention
|
||||||
|
@extend .wy-alert.wy-alert-warning
|
||||||
|
.section ul, ul.simple, ul.stimple ul, .toctree-wrapper ul
|
||||||
|
@extend .wy-plain-list-disc
|
||||||
|
.section ol, ol.simple, ol.arabic
|
||||||
|
@extend .wy-plain-list-decimal
|
||||||
|
.topic-title
|
||||||
|
font-weight: bold
|
||||||
|
margin-bottom: $base-line-height / 2
|
||||||
|
.toc-backref
|
||||||
|
color: $text-color
|
||||||
|
.align-right
|
||||||
|
float: right
|
||||||
|
margin: 0px 0px $base-line-height $base-line-height
|
||||||
|
.align-left
|
||||||
|
float: left
|
||||||
|
margin: 0px $base-line-height $base-line-height 0px
|
||||||
|
h1, h2, h3, h4, h5, h6, dl dt
|
||||||
|
.headerlink
|
||||||
|
display: none
|
||||||
|
visibility: hidden
|
||||||
|
font-size: 14px
|
||||||
|
@extend .icon
|
||||||
|
&:after
|
||||||
|
visibility: visible
|
||||||
|
content: "\f0c1"
|
||||||
|
font-family: fontawesome-webfont
|
||||||
|
display: inline-block
|
||||||
|
&:hover .headerlink
|
||||||
|
display: inline-block
|
||||||
|
|
||||||
|
table.docutils
|
||||||
|
@extend .wy-table
|
||||||
|
@extend .wy-table-bordered-all
|
||||||
|
&:not(.field-list)
|
||||||
|
@extend .wy-table-striped
|
||||||
|
table.docutils.field-list
|
||||||
|
@extend .wy-table
|
||||||
|
border: none
|
||||||
|
td
|
||||||
|
border: none
|
||||||
|
.field-name
|
||||||
|
padding-right: 5px
|
||||||
|
text-align: left
|
||||||
|
.field-body
|
||||||
|
text-align: left
|
||||||
|
padding-left: 0
|
||||||
|
dl
|
||||||
|
dt
|
||||||
|
@extend code
|
||||||
|
display: inline-block
|
||||||
|
margin: $base-line-height / 4 0
|
||||||
|
font-size: 80%
|
||||||
|
line-height: normal
|
||||||
|
background: $gray-lighter
|
||||||
|
color: $gray-dark
|
||||||
|
border: none
|
||||||
|
border-left: solid 3px $gray-light
|
||||||
|
padding: $base-line-height / 4
|
||||||
|
.headerlink
|
||||||
|
color: $text-color
|
||||||
|
font-size: 100% !important
|
||||||
|
.descname, .descclassname, big, em
|
||||||
|
font-size: 100% !important
|
||||||
|
line-height: normal
|
||||||
|
dt:first-child
|
||||||
|
margin-top: 0
|
||||||
|
dd
|
||||||
|
margin-left: $base-line-height
|
||||||
|
|
||||||
|
dl dl
|
||||||
|
dt
|
||||||
|
@extend code
|
||||||
|
display: inline-block
|
||||||
|
margin-bottom: $base-line-height / 4
|
||||||
|
font-size: 80%
|
||||||
|
line-height: normal
|
||||||
|
.headerlink
|
||||||
|
color: $text-color
|
||||||
|
font-size: 100% !important
|
||||||
|
tt
|
||||||
|
font-family: $code-font-family
|
||||||
|
&.literal
|
||||||
|
@extend code
|
||||||
|
blockquote
|
||||||
|
margin-left: $base-line-height
|
||||||
|
line-height: $base-line-height
|
||||||
|
margin-bottom: $base-line-height
|
||||||
|
|
||||||
|
|
||||||
|
#search-results
|
||||||
|
.search li
|
||||||
|
margin-bottom: $base-line-height
|
||||||
|
border-bottom: solid 1px $table_border_color
|
||||||
|
padding-bottom: $base-line-height
|
||||||
|
.search li:first-child
|
||||||
|
border-top: solid 1px $table_border_color
|
||||||
|
padding-top: $base-line-height
|
||||||
|
.search li a
|
||||||
|
font-size: 120%
|
||||||
|
margin-bottom: $base-line-height / 2
|
||||||
|
display: inline-block
|
||||||
|
.context
|
||||||
|
color: $text-medium
|
||||||
|
font-size: 90%
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
0
src/sphinx_rtd_theme/sass/_theme_variables.sass
Normal file
0
src/sphinx_rtd_theme/sass/_theme_variables.sass
Normal file
15
src/sphinx_rtd_theme/sass/badge_only.sass
Normal file
15
src/sphinx_rtd_theme/sass/badge_only.sass
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
// ------------------------------------------------------------
|
||||||
|
// CONTRIBUTORS, PLEASE READ THIS!
|
||||||
|
// ------------------------------------------------------------
|
||||||
|
// This generates the RTD sticky badge for non RTD themes. As
|
||||||
|
// always, only files labeled "theme_*.sass should be edited".
|
||||||
|
// ------------------------------------------------------------
|
||||||
|
|
||||||
|
@import wyrm_core/wy_variables
|
||||||
|
@import theme_variables
|
||||||
|
@import bourbon
|
||||||
|
@import neat
|
||||||
|
@import wyrm_core/mixin
|
||||||
|
@import wyrm_core/grid_settings
|
||||||
|
@import _theme_badge_fa
|
||||||
|
@import _theme_badge
|
51
src/sphinx_rtd_theme/sass/theme.sass
Normal file
51
src/sphinx_rtd_theme/sass/theme.sass
Normal file
|
@ -0,0 +1,51 @@
|
||||||
|
// ------------------------------------------------------------
|
||||||
|
// CONTRIBUTORS, PLEASE READ THIS!
|
||||||
|
// ------------------------------------------------------------
|
||||||
|
// This theme pulls from other frontend projects. The only
|
||||||
|
// things you should edit are the sass files that start with
|
||||||
|
// "theme_*.sass". All other files are loaded through bower.
|
||||||
|
// ------------------------------------------------------------
|
||||||
|
|
||||||
|
// Variable defaults set by Wyrm
|
||||||
|
@import wyrm_core/wy_variables
|
||||||
|
|
||||||
|
// Variable overrides that change coloring and fonts for your theme.
|
||||||
|
@import theme_variables
|
||||||
|
|
||||||
|
// bourbon.io framework
|
||||||
|
@import bourbon
|
||||||
|
|
||||||
|
// Bourbon.io/neat framework, with some default media queries
|
||||||
|
@import wyrm_core/grid_settings
|
||||||
|
@import neat
|
||||||
|
|
||||||
|
// Custom reset
|
||||||
|
@import wyrm_core/reset
|
||||||
|
|
||||||
|
// Some compass libs that bourbon doesn't have
|
||||||
|
@import compass/typography/vertical_rhythm
|
||||||
|
@import compass/typography/text/ellipsis
|
||||||
|
|
||||||
|
// Wyrm mixins
|
||||||
|
@import wyrm_core/mixin
|
||||||
|
|
||||||
|
// Wyrm core styles used in this theme
|
||||||
|
@import wyrm_core/font_awesome
|
||||||
|
@import wyrm_core/alert
|
||||||
|
@import wyrm_core/button
|
||||||
|
@import wyrm_core/dropdown
|
||||||
|
@import wyrm_core/form
|
||||||
|
@import wyrm_core/generic
|
||||||
|
@import wyrm_core/grid_layout
|
||||||
|
@import wyrm_core/table
|
||||||
|
@import wyrm_core/type
|
||||||
|
|
||||||
|
// Pygments styling
|
||||||
|
@import wyrm_addons/rst/pygments
|
||||||
|
@import wyrm_addons/rst/pygments_light
|
||||||
|
|
||||||
|
// Theme specific styles
|
||||||
|
@import theme_breadcrumbs
|
||||||
|
@import theme_nav
|
||||||
|
@import theme_badge
|
||||||
|
@import theme_rst
|
Before Width: | Height: | Size: 193 KiB After Width: | Height: | Size: 193 KiB |
Loading…
Reference in New Issue
Block a user