Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Sphinx docs updates

  • Loading branch information...
commit 4a8c0b8f9ebed115f0c607d816f121810daf24ae 1 parent d299281
R. Saravanan authored
View
9 docs/Makefile
@@ -17,10 +17,12 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+.PHONY: help clean cleanpages pages git_pages 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 " pages to export standalone HTML files to project pages repository"
+ @echo " git_pages to export pages and sync local project pages with Github"
@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"
@@ -52,6 +54,11 @@ pages:
@echo
@echo "Build finished. The HTML pages are in $(PAGESDIR)."
+git_pages: pages
+ cd $(PAGESDIR) && git add -A && git commit -a -m "Publishing $(PKGNAME) at `date`" && git push origin gh-pages
+ @echo
+ @echo "Published package $(PKGNAME) at `date`"
+
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
View
24 docs/_templates/layout.html
@@ -1,5 +1,29 @@
{% extends "!layout.html" %}
+{% block header %}
+ <div class="header-wrapper">
+ <div class="header">
+ {%- if logo %}
+ <p class="logo"><a href="{{ pathto(master_doc) }}">
+ <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+ </a></p>
+ {%- endif %}
+ {%- block headertitle %}
+ <div class="headertitle">
+ <a href="http://code.mindmeldr.com">code.mindmeldr.com</a>/<a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>
+ </div>
+ {%- endblock %}
+ <div class="rel">
+ {%- for rellink in rellinks|reverse %}
+ <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags|e }}"
+ {{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a>
+ {%- if not loop.last %}{{ reldelim2 }}{% endif %}
+ {%- endfor %}
+ </div>
+ </div>
+ </div>
+{% endblock %}
+
{%- block extrahead %}
{{ super() }}
<script type="text/javascript">
View
56 docs/conf.py
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
-# gcowsay documentation build configuration file, created by
+# otrace documentation build configuration file, created by
# sphinx-quickstart on Sat Oct 6 10:23:49 2012.
#
# This file is execfile()d with the current directory set to its containing dir.
@@ -13,15 +13,26 @@
import sys, os
-parentdir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-sys.path.insert(0,parentdir)
+custom_theme = "sphinx-bootstrap"
+custom_theme = ""
+
+current_dir = os.path.abspath(os.path.dirname(__file__))
+parent_dir = os.path.dirname(current_dir)
+pkg_name = os.path.basename(parent_dir)
+pkg_dir = os.path.join(parent_dir, pkg_name)
+sys.path.insert(0, pkg_dir)
+
+if custom_theme:
+ theme_dir = os.path.join(current_dir, '_themes', custom_theme)
+ sys.path.insert(0, theme_dir)
+
try:
import about
except ImportError:
about = None
# General information about the project.
-project = os.path.basename(os.path.dirname(os.getcwd()))
+project = pkg_name
copyright = u'2012, R. Saravanan'
# The version info for the project you're documenting, acts as replacement for
@@ -37,6 +48,9 @@
version = about.version
release = about.version
+def setup(app):
+ app.add_config_value('custom_theme', '', True)
+
# 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.
@@ -49,10 +63,10 @@
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = [] if custom_theme else ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
@@ -75,7 +89,7 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
-exclude_patterns = []
+exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
@@ -102,22 +116,32 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'agogo'
+html_theme = custom_theme or 'agogo'
# 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 = {}
+if html_theme == "sphinx-bootstrap":
+ html_theme_options = {
+ 'analytics_code': 'UA-35342722-1',
+ 'github_user': 'mitotic',
+ 'github_repo': 'otrace',
+ 'twitter_username': 'otrace',
+ 'home_url': 'http://code.mindmeldr.com/otrace',
+ # 'disqus_shortname': 'mindcoder',
+ }
+
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+html_theme_path = ['_themes']
# 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
+html_short_title = 'otrace'
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
@@ -158,7 +182,7 @@
#html_split_index = False
# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
@@ -175,7 +199,7 @@
#html_file_suffix = None
# Output file base name for HTML help builder.
-htmlhelp_basename = 'gcowsaydoc'
+htmlhelp_basename = 'otracedoc'
# -- Options for LaTeX output --------------------------------------------------
@@ -194,7 +218,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
- ('index', 'gcowsay.tex', u'gcowsay Documentation',
+ ('index', 'otrace.tex', u'otrace Documentation',
u'R. Saravanan', 'manual'),
]
@@ -224,7 +248,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('index', 'gcowsay', u'gcowsay Documentation',
+ ('index', 'otrace', u'otrace Documentation',
[u'R. Saravanan'], 1)
]
@@ -238,8 +262,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- ('index', 'gcowsay', u'gcowsay Documentation',
- u'R. Saravanan', 'gcowsay', 'One line description of project.',
+ ('index', 'otrace', u'otrace Documentation',
+ u'R. Saravanan', 'otrace', 'One line description of project.',
'Miscellaneous'),
]
View
4 docs/index.rst
@@ -6,8 +6,8 @@
OTrace
===================================
-*Updates: The latest version is `0.30.9 <http://pypi.python.org/pypi/otrace>`_,
-released August 26, 2012.*
+*Updates:* The latest version is `0.30.9 <http://pypi.python.org/pypi/otrace>`_,
+released August 26, 2012.
*OTrace* is an object-oriented python debugger for nonlinear
tracing of asynchronous or multithreaded interactive programs.Its
Please sign in to comment.
Something went wrong with that request. Please try again.