Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
b5f15d5
re-arrange the package layout
itziakos Sep 12, 2014
6554449
update the copyright dates
itziakos Sep 12, 2014
a79cf72
flake8 fixes
itziakos Sep 13, 2014
637a622
add unittest2 to the requirements
itziakos Sep 13, 2014
b5922cb
place requirements into a separate file
itziakos Sep 13, 2014
c6ad5b3
factor out Item
itziakos Sep 15, 2014
a0d4374
use the Item as a base class
itziakos Sep 15, 2014
a834759
subclass namedtuple
itziakos Sep 15, 2014
ccb8426
factor out section refactoring functions to the sections module
itziakos Sep 23, 2014
a6ba097
provide eaiser access to the Items and fix code
itziakos Sep 23, 2014
898875e
move code for old_styles to the styles module
itziakos Sep 23, 2014
2db9264
remove unused classes
itziakos Sep 23, 2014
48f9c80
rework class and function tests to old_style tests
itziakos Sep 23, 2014
fce78f2
minor cleanup
itziakos Sep 23, 2014
a30b503
minor cleanup
itziakos Sep 23, 2014
3834d8f
update tests
itziakos Sep 23, 2014
1db7518
add a subpackage for renderers
itziakos Oct 15, 2014
312c7db
better separate the items and thier parsing constructors from the ren…
itziakos Oct 17, 2014
9593657
start updading the section rendering methods
itziakos Oct 17, 2014
5fb52ab
update the section methods
itziakos Oct 18, 2014
b5cb8ae
fix tests
itziakos Oct 21, 2014
1ea891a
rework travis yml matrix to fix the failure to built in python 3
itziakos Oct 21, 2014
a3bf4c9
Merge remote-tracking branch 'origin/feature/styles' into feature/styles
itziakos Oct 21, 2014
05c8c76
fix travis.yml
itziakos Oct 21, 2014
bbcc278
more typos
itziakos Oct 21, 2014
32261d9
more cleanup
itziakos Oct 21, 2014
e1fe36b
group tests for old_style in one file
itziakos Oct 21, 2014
30e8f6f
factor out a Style class
itziakos Oct 21, 2014
85a9301
fix code so that the documentation compiles properly
itziakos Oct 21, 2014
db6c8e1
some cleanup on the docstrings
itziakos Oct 21, 2014
77590b0
some cleanup on the rst code
itziakos Oct 21, 2014
dc02f15
fix Attribue docstring
itziakos Oct 22, 2014
f7e9b05
use the default role for the classifiers
itziakos Oct 22, 2014
3588096
Revert "use the default role for the classifiers"
itziakos Oct 22, 2014
1871d9e
Merge branch 'master' into feature/styles
itziakos Nov 5, 2014
57d63b4
use sectiondoc and fix tests
itziakos Nov 13, 2014
cf2afe2
Merge branch 'master' into feature/styles
itziakos Dec 5, 2014
d2797c9
fix typo
itziakos Dec 5, 2014
e388578
fix doc
itziakos Dec 5, 2014
6658434
fix old package references
itziakos Dec 5, 2014
a8c18cd
update warning message to use sectiondoc
itziakos Dec 11, 2014
bec17ce
rename definition item -> to or definition item
itziakos Dec 11, 2014
f7b8343
Update __init__.py
itziakos Feb 11, 2015
0d6ab14
update docstring
itziakos Feb 27, 2015
6c1542c
update docstrings
itziakos Feb 27, 2015
1c44f5f
update and rename the BaseDoc -> DocRender
itziakos Feb 27, 2015
12deb93
update docstrings
itziakos Feb 27, 2015
637aafa
fix typo
itziakos Feb 27, 2015
3adc265
fix docstrings
itziakos Feb 28, 2015
853fefe
update README.rst
itziakos Feb 28, 2015
377bced
remove old documentation
itziakos Feb 28, 2015
34ec491
add documentation for the new design
itziakos Feb 28, 2015
42dea45
add styles to the api reference
itziakos Feb 28, 2015
41aa84a
update index toctree
itziakos Feb 28, 2015
fd033c6
use the travis dockers
itziakos Feb 28, 2015
38421a0
update conf.py to merge the class docstrings with the `__init__` method
itziakos Mar 2, 2015
507f434
add support for parsing Arguments and Paramaters sections in class
itziakos Mar 2, 2015
d7d1d39
minor cleanup
itziakos Mar 2, 2015
0b703a8
Merge branch 'master' into feature/styles
itziakos Mar 2, 2015
56bfe44
fix docstrings
itziakos Mar 2, 2015
8a0c2be
reduce the depth of the toctree
itziakos Mar 2, 2015
d7b8508
Update old_style.rst
itziakos Mar 2, 2015
d94e941
rename old_style to legacy
itziakos Aug 7, 2015
ca3bd44
Merge remote-tracking branch 'origin/feature/styles' into feature/styles
itziakos Aug 7, 2015
8d8b02f
update documentation
itziakos Aug 7, 2015
e75804f
use alabaster sphinx theme
itziakos Aug 7, 2015
2cedb06
simplify package versioning
itziakos Aug 7, 2015
10fb219
update README
itziakos Aug 7, 2015
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This software is OSI Certified Open Source Software.
OSI Certified is a certification mark of the Open Source Initiative.

Copyright (c) 2006, Enthought, Inc.
Copyright (c) 2012-2014, Enthought, Inc.
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
12 changes: 9 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ Key aims of **sectiondoc** are:

- Do not change the order of sections.
- Allow sphinx directives between (and inside) section blocks.
- Custom rendering styles
- Easier to debug (native support for debugging) and extend
(future versions).


Repository
----------

Expand All @@ -35,14 +37,18 @@ using::
Installation
------------

1. Install ``sectiondoc`` from pypi using pip::
Install ``sectiondoc`` from pypi using pip::

$ pip install sectiondoc

2. Add sectiondoc to the extensions variable of your sphinx ``conf.py``::
Usage
-----


Styles can be selected by referencing in ``conf.py`` the module they are defined::

extensions = [
...,
'sectiondoc',
'sectiondoc.styles.legacy',
...,
]
58 changes: 0 additions & 58 deletions docs/source/architecture.rst

This file was deleted.

82 changes: 0 additions & 82 deletions docs/source/components.rst

This file was deleted.

10 changes: 7 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@
extensions = ['sectiondoc',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.viewcode']
'sphinx.ext.viewcode',
'sphinx.ext.autosummary']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = []

# The suffix of source filenames.
source_suffix = '.rst'
Expand Down Expand Up @@ -60,11 +61,14 @@
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

autodoc_member_order = 'groupwise'
autoclass_content = 'both'

# -- 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 = 'default'
html_theme = 'alabaster'

# Output file base name for HTML help builder.
htmlhelp_basename = 'SectionDocdoc'
Expand Down
43 changes: 0 additions & 43 deletions docs/source/extending.rst

This file was deleted.

9 changes: 3 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,10 @@ Contents
========

.. toctree::
:maxdepth: 2
:maxdepth: 1

usage
architecture
components
extending
rendering
styles
reference
authors
todo
Expand All @@ -25,4 +23,3 @@ Indices and tables
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

Loading