Changeset 1515


Ignore:
Timestamp:
Mar 11, 2014 1:05:15 AM (9 years ago)
Author:
jemian
Message:

cleanup, apply consistency, correct documentation problems

Location:
specdomain/trunk/src/specdomain
Files:
2 deleted
12 edited

Legend:

Unmodified
Added
Removed
  • specdomain/trunk/src/specdomain/CHANGES

    r1513 r1515  
    77
    88
    9 Version 1.04 (not released)
     9Version 1.04.01 (2014-03-10)
    1010-----------------------------------
    1111
  • specdomain/trunk/src/specdomain/README

    r1099 r1515  
    77Acquisition of scientific instruments.
    88
    9 This code extracts useful documentation from SPEC macro source code files.
     9This code extracts useful documentation from
     10SPEC macro source code files.
     11
     12:home: http://specdomain.readthedocs.org
     13:svn:  https://subversion.xray.aps.anl.gov/bcdaext/specdomain/trunk/src/specdomain/
     14:trac: https://subversion.xray.aps.anl.gov/trac/bcdaext/wiki/SpecDomain
     15:PyPI: http://pypi.python.org/sphinxcontrib-specdomain
  • specdomain/trunk/src/specdomain/VERSION

    r1513 r1515  
    1 1.04
     11.04.01
  • specdomain/trunk/src/specdomain/doc/bugs.rst

    r1028 r1515  
    33.. _bugs:
    44
    5 ===========
     5==========
    66Known bugs
    7 ===========
     7==========
    88
     9* move this list to the **TRAC** site:
     10  https://subversion.xray.aps.anl.gov/trac/bcdaext/wiki/SpecDomain
    911* Duplicate ID warnings, for now, ignore them, the warning will be resolved in a future revision
    1012* roles should link to directives, see *example.mac* to illustrate the problem
  • specdomain/trunk/src/specdomain/doc/conf.py

    r1513 r1515  
    4747# General information about the project.
    4848project = u'sphinxcontrib-specdomain'
    49 copyright = u'2012, BCDA, Advanced Photon Source, Argonne National Laboratory'
     49copyright = u'2012-2014, BCDA, Advanced Photon Source, Argonne National Laboratory'
    5050
    5151# The version info for the project you're documenting, acts as replacement for
  • specdomain/trunk/src/specdomain/doc/downloads.rst

    r1128 r1515  
    33.. _downloads:
    44
    5 ===========
     5=========
    66Downloads
    7 ===========
     7=========
    88
    9 :home:
    10     http://subversion.xray.aps.anl.gov/admin_bcdaext/specdomain
     9:home:  http://specdomain.readthedocs.org
    1110
    1211:svn trunk:
     
    1716    - https://subversion.xray.aps.anl.gov/bcdaext/specdomain/tags/src/
    1817
    19 :svn source tarballs:
    20        
    21     - https://subversion.xray.aps.anl.gov/bcdaext/specdomain/tags
     18:PyPI: http://pypi.python.org/sphinxcontrib-specdomain
  • specdomain/trunk/src/specdomain/doc/index.rst

    r1088 r1515  
    11.. $Id$
    22
    3 =======================================================
     3==============================================
    44Documenting SPEC Macro Source Code with Sphinx
    5 =======================================================
     5==============================================
    66
    77.. include:: ../README
    88
    9 .. note::
    10         This project is available online.  See :ref:`downloads`.
    11        
    12                 documentation:
    13                         http://subversion.xray.aps.anl.gov/admin_bcdaext/specdomain
    14                
    15                 svn:
    16                         https://subversion.xray.aps.anl.gov/bcdaext/specdomain/trunk/src/specdomain/
    17 
    18 
    199Contents
    20 ==================
     10========
    2111
    2212.. toctree::
  • specdomain/trunk/src/specdomain/doc/todo.rst

    r1027 r1515  
    33.. _todo:
    44
    5 =============
     5==========
    66TO-DO List
    7 =============
     7==========
    88
     9* move this list to the **TRAC** site:
     10  https://subversion.xray.aps.anl.gov/trac/bcdaext/wiki/SpecDomain
    911* add support to document SPEC array declarations
    1012* improve the display of directives for variables and macros
  • specdomain/trunk/src/specdomain/setup.py

    r1036 r1515  
    1010version = open('VERSION').read().strip()
    1111
    12 requires = ['Sphinx>=0.6']
     12requires = ['Sphinx>=1.1.1']
    1313
    1414# classifiers: http://pypi.python.org/pypi?%3Aaction=list_classifiers
     
    1717    name='sphinxcontrib-specdomain',
    1818    version=version,
    19     url='http://subversion.xray.aps.anl.gov/admin_bcdaext/specdomain',
    20     #'http://bitbucket.org/birkenfeld/sphinx-contrib',
    21     #download_url='http://pypi.python.org/pypi/sphinxcontrib-specdomain',
     19    url='http://specdomain.readthedocs.org',
    2220    license='Argonne OPEN SOURCE LICENSE, see LICENSE file for details',
    2321    author='Pete Jemian',
  • specdomain/trunk/src/specdomain/sphinxcontrib/__init__.py

    r908 r1515  
    77    distributed in the ``sphinx-contrib`` distribution.
    88
    9     :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
    10     :license: BSD, see LICENSE for details.
     9    :copyright: Copyright 2012-2014 by the Sphinx team, see AUTHORS.
     10    :license: Argonne OPEN SOURCE LICENSE, see LICENSE for details.
    1111"""
    1212
  • specdomain/trunk/src/specdomain/sphinxcontrib/specdomain.py

    r1513 r1515  
    1111    for those who like elaborate docstrings.
    1212
    13     :copyright: Copyright 2012 by BCDA, Advanced Photon Source, Argonne National Laboratory
     13    :copyright: Copyright 2012-2014 by BCDA, Advanced Photon Source, Argonne National Laboratory
    1414    :license: ANL Open Source License, see LICENSE for details.
    1515"""
  • specdomain/trunk/src/specdomain/sphinxcontrib/specmacrofileparser.py

    r1513 r1515  
    1515code blocks in the SPEC macro source code file across multiple lines.
    1616
    17 :copyright: Copyright 2012 by BCDA, Advanced Photon Source, Argonne National Laboratory
     17:copyright: Copyright 2012-2014 by BCDA, Advanced Photon Source, Argonne National Laboratory
    1818:license: ANL Open Source License, see LICENSE for details.
    1919"""
Note: See TracChangeset for help on using the changeset viewer.