Links

Content Skeleton

This Page

Previous topic

Daemonwatch

Next topic

Matplotlib

Sphinx Extensions

taglist

Accessing file level docinfo/metadata with taglist extension.

{'AbtViz/docs/pyrootguithreads': {'mtime': 1344584902.0, u'orphan': u'True'},
 'TODO': {'mtime': 1357632961.0},
 '_docs/env': {'mtime': 1380767636.0},
 '_docs/python/index': {'mtime': 1380767636.0},
 '_docs/tools/cuisine': {'mtime': 1380767636.0},
 '_docs/tools/daemonwatch': {'mtime': 1380767636.0},
 '_docs/tools/fabric': {'mtime': 1380767636.0},
 '_docs/tools/index': {'mtime': 1380767636.0},
 'base/gcc': {'mtime': 1380716397.0},
 'base/index': {'mtime': 1380716397.0},
 'base/macports': {'mtime': 1380716397.0},
 'base/ssh': {'mtime': 1380716397.0},
 'cloud/openstack/index': {'mtime': 1380716399.0},
 'cloud/openstack/openstack_intro': {'mtime': 1380716399.0},
 'cuda/atomic': {'mtime': 1380716400.0},
 'cuda/cuda_capability': {'mtime': 1380716400.0},
 'cuda/cuda_cloud': {'mtime': 1380716400.0},
 'cuda/cuda_toolkit': {'mtime': 1380716400.0},
 'cuda/cudatoolkit': {'mtime': 1380716400.0},
 'cuda/curand': {'mtime': 1380716400.0},
 'cuda/emulation': {'mtime': 1380716400.0},
 'cuda/index': {'mtime': 1380716400.0},
 'cuda/pycuda/index': {'mtime': 1380716400.0},
 'cuda/pycuda/pycuda': {'mtime': 1380716400.0},
 'cuda/rcuda': {'mtime': 1380716400.0},
 'cuda/refs': {'mtime': 1380716400.0},
 'db/bdbxml/qxml/examples': {'mtime': 1380716399.0},
 'db/bdbxml/qxml/exist2qxml': {'mtime': 1380716399.0},
 'db/bdbxml/qxml/index': {'mtime': 1380716399.0},
 'db/index': {'mtime': 1380716399.0},
 'db/sqlite3': {'mtime': 1380716399.0},
 'db/valmon': {'mtime': 1380716399.0},
 'fossil/f': {'mtime': 1380716403.0},
 'fossil/fossil': {'mtime': 1380716403.0},
 'fossil/index': {'mtime': 1380716403.0},
 'geant4/api': {'mtime': 1380716402.0},
 'geant4/docs': {'mtime': 1380716402.0},
 'geant4/g4py/g4py_introduction': {'mtime': 1380716400.0},
 'geant4/geant4_gpu': {'mtime': 1380716402.0},
 'geant4/geant4_profiling': {'mtime': 1380716402.0},
 'geant4/geometry/DAE': {'mtime': 1380716402.0},
 'geant4/geometry/cad': {'mtime': 1380716402.0},
 'geant4/geometry/collada/export': {'mtime': 1380716400.0},
 'geant4/geometry/collada/index': {'mtime': 1380716400.0},
 'geant4/geometry/detdesc': {'mtime': 1380716402.0},
 'geant4/geometry/export/index': {'mtime': 1380716400.0},
 'geant4/geometry/gdml/gdml2wrl/gdml2wrl': {'mtime': 1380716402.0},
 'geant4/geometry/gdml/gdml_examine': {'mtime': 1380716402.0},
 'geant4/geometry/gdml/gdml_export': {'mtime': 1380716402.0},
 'geant4/geometry/gdml/gdml_g4gdml': {'mtime': 1380716402.0},
 'geant4/geometry/gdml/gdml_root': {'mtime': 1380716402.0},
 'geant4/geometry/gdml/implementation': {'mtime': 1380716402.0},
 'geant4/geometry/gdml/index': {'mtime': 1380716402.0},
 'geant4/geometry/gdml/intro': {'mtime': 1380716402.0},
 'geant4/geometry/index': {'mtime': 1380716402.0},
 'geant4/geometry/introduction': {'mtime': 1380716402.0},
 'geant4/geometry/other': {'mtime': 1380716402.0},
 'geant4/geometry/overview': {'mtime': 1380716402.0},
 'geant4/geometry/visualisation': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/booleanprocessor_warnings': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/index': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/instant_reality_player': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/overlapping_volumes': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/polyhedron': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/shapedb': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/vrml2file_export': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/vrml2file_format': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/vrml2file_implementation': {'mtime': 1380716402.0},
 'geant4/geometry/vrml2/vrml2file_patch': {'mtime': 1380716402.0},
 'geant4/giga': {'mtime': 1380716402.0},
 'geant4/index': {'mtime': 1380716402.0},
 'geant4/medical': {'mtime': 1380716402.0},
 'geant4/opticalphoton': {'mtime': 1380716402.0},
 'geant4/processes': {'mtime': 1380716402.0},
 'geant4/release_notes': {'mtime': 1380716402.0},
 'geant4/verbosity': {'mtime': 1380716402.0},
 'graphics/cgal/index': {'mtime': 1380716398.0},
 'graphics/collada/collada_geometry_elements': {'mtime': 1380716398.0},
 'graphics/collada/collada_intro': {'mtime': 1380716398.0},
 'graphics/collada/index': {'mtime': 1380716398.0},
 'graphics/collada/pycollada/triangulation': {'mtime': 1380716398.0},
 'graphics/index': {'mtime': 1380716398.0},
 'graphics/mesh/index': {'mtime': 1380716398.0},
 'graphics/mesh/mesh_generation': {'mtime': 1380716398.0},
 'graphics/mesh/meshlab': {'mtime': 1380716398.0},
 'graphics/mesh/meshpy': {'mtime': 1380716398.0},
 'graphics/vrml/index': {'mtime': 1380716398.0},
 'graphics/vrml/samples/index': {'mtime': 1380716398.0},
 'graphics/vrml/spec': {'mtime': 1380716398.0},
 'graphics/vrml/vrml': {'mtime': 1380716398.0},
 'index': {u'modified': u'2012-07-10 08:42:54+00:00',
           'mtime': 1380716404.0,
           u'tags': u'Red,Green,Blue'},
 'install': {'mtime': 1380716404.0},
 'java/index': {'mtime': 1380716399.0},
 'java/jni/hello/HelloWorld': {'mtime': 1380716399.0},
 'java/jni/index': {'mtime': 1380716399.0},
 'linux/centos/index': {'mtime': 1380716402.0},
 'linux/centos/intro': {'mtime': 1380716402.0},
 'linux/chroot': {'mtime': 1380716402.0},
 'linux/index': {'mtime': 1380716402.0},
 'linux/non-root-package-management': {'mtime': 1380716402.0},
 'linux/ntp': {'mtime': 1380716402.0},
 'linux/redhat/index': {'mtime': 1380716402.0},
 'linux/redhat/rpm': {'mtime': 1380716402.0},
 'linux/ubuntu/apt-get': {'mtime': 1380716402.0},
 'linux/ubuntu/basics': {'mtime': 1380716402.0},
 'linux/ubuntu/dpkg': {'mtime': 1380716402.0},
 'linux/ubuntu/index': {'mtime': 1380716402.0},
 'linux/ubuntu/package_management': {'mtime': 1380716402.0},
 'linux/ubuntu/unmet_dependencies': {'mtime': 1380716402.0},
 'llvm/index': {'mtime': 1380716404.0},
 'llvm/llvm': {'mtime': 1380716404.0},
 'log/May2012': {'mtime': 1344584903.0},
 'matplotlib/index': {'mtime': 1357632961.0},
 'matplotlib/installation': {'mtime': 1357632961.0},
 'matplotlib/macports': {'mtime': 1357632961.0},
 'matplotlib/nuwapy': {'mtime': 1357632961.0},
 'muon_simulation/chroma/bvh': {'mtime': 1380716403.0},
 'muon_simulation/chroma/chroma_geant4_integration': {'mtime': 1380716403.0},
 'muon_simulation/chroma/chroma_geometry': {'mtime': 1380716403.0},
 'muon_simulation/chroma/chroma_physics': {'mtime': 1380716403.0},
 'muon_simulation/chroma/chroma_server': {'mtime': 1380716403.0},
 'muon_simulation/chroma/cuda': {'mtime': 1380716403.0},
 'muon_simulation/chroma/detector': {'mtime': 1380716403.0},
 'muon_simulation/chroma/hardware': {'mtime': 1380716403.0},
 'muon_simulation/chroma/index': {'mtime': 1380716403.0},
 'muon_simulation/chroma/prerequisites': {'mtime': 1380716403.0},
 'muon_simulation/chroma/propagate': {'mtime': 1380716403.0},
 'muon_simulation/chroma/pycuda': {'mtime': 1380716403.0},
 'muon_simulation/chroma/questions': {'mtime': 1380716403.0},
 'muon_simulation/chroma/refs': {'mtime': 1380716403.0},
 'muon_simulation/chroma/zeromq': {'mtime': 1380716403.0},
 'muon_simulation/index': {'mtime': 1380716403.0},
 'muon_simulation/optical_photon_weighting/history': {'mtime': 1380716403.0},
 'muon_simulation/optical_photon_weighting/index': {'mtime': 1380716403.0},
 'muon_simulation/optical_photon_weighting/opw': {'mtime': 1380716403.0},
 'muon_simulation/overview': {'mtime': 1380716403.0},
 'muon_simulation/profiling/base/analysis': {'mtime': 1380716403.0},
 'muon_simulation/profiling/base/index': {'mtime': 1380716403.0},
 'muon_simulation/profiling/base/stepping': {'mtime': 1380716403.0},
 'muon_simulation/profiling/index': {'mtime': 1380716403.0},
 'muon_simulation/profiling/references': {'mtime': 1380716403.0},
 'muon_simulation/tasks': {'mtime': 1380716403.0},
 'muon_simulation/techniques': {'mtime': 1380716403.0},
 'mysql/index': {'mtime': 1380716404.0},
 'mysql/information_schema': {'mtime': 1380716404.0},
 'mysql/mysqlrpm': {'mtime': 1380716404.0},
 'mysqlhotcopy/index': {'mtime': 1380716400.0},
 'mysqlhotcopy/lessons': {'mtime': 1380716400.0},
 'mysqlhotcopy/locking': {'mtime': 1380716400.0},
 'mysqlhotcopy/mysql_repair_table': {'mtime': 1380716400.0},
 'mysqlhotcopy/mysql_repair_table_live': {'mtime': 1380716400.0},
 'mysqlhotcopy/mysqlhotcopy': {'mtime': 1380716400.0},
 'mysqlhotcopy/steps': {'mtime': 1380716400.0},
 'nose/index': {'mtime': 1380716397.0},
 'nose/plugins/ctx': {'mtime': 1380716397.0},
 'nose/plugins/index': {'mtime': 1380716397.0},
 'npy/index': {'mtime': 1357632960.0},
 'npy/mysql_numpy': {'mtime': 1357632960.0},
 'opencl/index': {'mtime': 1380716402.0},
 'opencl/pyopencl': {'mtime': 1380716402.0},
 'opencl/refs': {'mtime': 1380716402.0},
 'opencl/swan': {'mtime': 1380716402.0},
 'plot/fromcsv': {'mtime': 1344584904.0},
 'plot/graph': {'mtime': 1344584904.0},
 'plot/index': {'mtime': 1380716402.0},
 'plot/svgcharts/cqpack': {'mtime': 1380716402.0},
 'plot/svgcharts/index': {'mtime': 1380716402.0},
 'plot/svgcharts/svgcharts': {'mtime': 1380716402.0},
 'plot/svgplotlib/index': {'mtime': 1380716402.0},
 'plot/svgplotlib/svgplotlib': {'mtime': 1380716402.0},
 'pypy/index': {'mtime': 1380716397.0},
 'qxml/examples': {'mtime': 1380716399.0},
 'qxml/exist2qxml': {'mtime': 1380716399.0},
 'qxml/index': {'mtime': 1380716399.0},
 'root/cling/index': {'mtime': 1380716398.0},
 'root/index': {'mtime': 1380716398.0},
 'root/release_notes': {'mtime': 1380716398.0},
 'root/rootdoc': {'mtime': 1344584903.0},
 'scm/altbackup': {'mtime': 1380716399.0},
 'scm/altquery': {'mtime': 1380716399.0},
 'scm/bitbucket/index': {'mtime': 1380716399.0},
 'scm/bitbucket/migration': {'mtime': 1380716399.0},
 'scm/bitbucket/trac2bitbucket': {'mtime': 1380716399.0},
 'scm/dev': {'mtime': 1357632960.0},
 'scm/index': {'mtime': 1380716399.0},
 'scm/monitor/dayabay': {'mtime': 1380767636.0},
 'scm/monitor/hku': {'mtime': 1344584904.0},
 'scm/monitor/ihep': {'mtime': 1346404126.0},
 'scm/monitor/index': {u'modified': u'2012-07-10 08:42:54+00:00',
                       'mtime': 1345079098.0,
                       u'tags': u'Sphinx'},
 'scm/notes': {'mtime': 1357632960.0},
 'scm/scm-backup': {'mtime': 1380716399.0},
 'scm/svn2git/index': {'mtime': 1380716399.0,
                       u'other': u'svn git',
                       u'tags': u'svn git'},
 'scm/svn2git/svn2git': {'mtime': 1380716399.0},
 'sysadmin/index': {'mtime': 1380716397.0},
 'sysadmin/mars': {'mtime': 1344584902.0},
 'sysadmin/migration/index': {'mtime': 1344584902.0},
 'sysadmin/migration/trac2github': {'mtime': 1344584902.0},
 'sysadmin/migration/tracwiki2sphinx': {'mtime': 1380716397.0},
 'sysadmin/monitoring': {'mtime': 1344584902.0},
 'trac/admin/index': {'mtime': 1357632960.0},
 'trac/admin/shrinkage': {'mtime': 1357632960.0},
 'trac/index': {'mtime': 1380716403.0}}

htmlrole

Raw html style and roles are included with:

.. include:: /sphinxext/roles.txt

Note that absolute include paths are actually relative to sphinx source directory.

For this page simply including roles.txt would work. That include is invisible, so a literalinclude to allow to see the source.

.. raw:: html

    <style type="text/css">
        span.alarm { color: red; } 
        span.warn { color: orange; } 
        span.ok { color: green; } 
    </style>

.. role:: alarm
.. role:: warn
.. role:: ok


Here is an example of using the roles some alarming text and some warning text and some ok text and back to normal

The RST of the above line is:

Here is an example of using the roles :alarm:`some alarming text` and :warn:`some warning text` and :ok:`some ok text` and back to normal

stockchart

bashinclude

Directive to extract the RST from a standard bash usage function. Did not pursue this approach, instead using bash2rst.py script to extract RST from bash usage messages and walk toctrees that are embedded therein. This way the migration to RST documentation for bash functions can be done piecemeal as it is useful to so so.