Eric Holscher
7e7f42367d
Fix Sphinx 1.3
2017-06-29 10:46:30 -07:00
Eric Holscher
86a4de1668
Don’t show modules with no content.
2017-06-29 10:45:54 -07:00
Eric Holscher
4428ecd6e8
Add ability to process Napolean docstrings.
2017-06-27 17:40:34 -07:00
Eric Holscher
efb541f78a
Add ability to add API to top-level TOC.
2017-06-27 17:12:47 -07:00
Eric Holscher
3233bc0ac7
Fix templates to nest functions and use short names
2017-06-27 17:12:17 -07:00
Eric Holscher
316457e9fc
Merge pull request #112 from toomanybrians/patch-1
...
fix typo in templates.rst
2017-06-13 12:06:31 -07:00
Brian Madden
defbfc517a
fix typo in templates.rst
2017-05-03 23:01:50 -05:00
Anthony
152ea1a521
Merge pull request #104 from rtfd/python-ast
...
Start altering the pydocstyle AST parser for our needs
2017-04-07 18:06:17 -07:00
Anthony
e7a624254a
Merge pull request #106 from rtfd/fix-argument-call
...
Fix Python argument parsing for Call nodes
2017-04-07 17:55:25 -07:00
Eric Holscher
24b4f871ae
Merge pull request #105 from rtfd/extension-name
...
Allow for toplevel module as Sphinx extension
2017-04-07 16:57:42 -07:00
Anthony Johnson
715b6662e5
Fix Python argument parsing for Call nodes
...
This previous was throwing exceptions in some cases where Attribute nodes were
used instead of Name nodes.
2017-04-07 16:36:23 -07:00
Anthony Johnson
df74247128
Allow for toplevel module as Sphinx extension
...
Instead of requiring:
extensions = ['autoapi.extension']
This allows for the toplevel:
extensions = ['autoapi']
This is more intuitive for users, as extension is an internal concept.
2017-04-07 15:33:39 -07:00
Anthony Johnson
2603729925
Fix some more parsing issues
2017-04-07 15:25:34 -07:00
Anthony Johnson
0faeb500ee
More fixes
2017-04-07 13:12:10 -07:00
Anthony Johnson
8da39241a7
Fix tox config
2017-04-07 12:01:17 -07:00
Anthony Johnson
3c6e0e4015
Start altering the pydocstyle AST parser for our needs
...
This forks some of the pydocstyle AST parser into out mapper. Eventually, some
of the other operations such as parsing arguments and performing full name
lookup can be moved in as well. For now, this is not doing any extra assignment
tracking/etc, several of these operations will just throw this information out.
Refs #99
2017-04-07 11:46:57 -07:00
Eric Holscher
8f798c8243
Merge pull request #95 from rtfd/fix-under-15
...
Add fix to version checking on <1.5
2017-03-02 14:20:39 -08:00
Eric Holscher
426d677324
Fix review feedback
2017-03-02 14:18:39 -08:00
Eric Holscher
d7e8e13613
Don't use string
2017-02-08 10:12:52 -05:00
Eric Holscher
6024223d9e
Add fix to version checking on <1.5
2017-02-08 09:53:19 -05:00
Eric Holscher
5529237fb5
Merge pull request #94 from AWhetter/fix_sphinx_1_5
...
Fix for Sphinx 1.5
2017-02-07 15:24:17 -05:00
Ashley Whetter
a9521553d9
Fix for Sphinx 1.5
2017-02-01 17:14:32 -08:00
Anthony
6d9a465964
Merge pull request #90 from rtfd/fix-path-output
...
Return the proper path in pathname function.
2016-11-04 20:54:46 -07:00
Eric Holscher
d34af13767
Fix pathing
2016-11-04 20:50:05 -07:00
Eric Holscher
b6ae837be9
Merge pull request #89 from rtfd/fix-docstring-whitespace
...
Implement prepare_docstring filter that wraps Sphinx's
2016-11-04 16:58:35 -07:00
Eric Holscher
875d6b6ffa
Fix tests
2016-11-04 15:47:57 -07:00
Eric Holscher
e8514dfee2
Use shortname for methods
2016-11-04 15:44:47 -07:00
Eric Holscher
5901291d3f
Remove nested parse
2016-11-04 15:37:46 -07:00
Eric Holscher
491f8c9065
Keep nested-parse
2016-11-04 15:34:48 -07:00
Eric Holscher
aa06999300
Nest the wrapper
2016-11-04 15:19:56 -07:00
Eric Holscher
ffb2130b55
Implement prepare_docstring filter that wraps Sphinx's
...
This allows us to output docstrings in a reasonable fashion.
2016-11-04 15:17:50 -07:00
Eric Holscher
5b69857df0
Merge pull request #87 from rtfd/toc-addition-extension
...
Build initial toctree insertion implementation
2016-11-04 13:43:59 -07:00
Eric Holscher
c557182525
Fix review feedback
2016-11-04 13:42:15 -07:00
Eric Holscher
215dd06e0a
Add basic test for TOC Tree insertion
2016-11-03 19:52:54 -07:00
Eric Holscher
73324fab7e
Remove unneeded index entry
2016-11-03 13:24:22 -07:00
Eric Holscher
c3db6e5bc8
Python 3 fixes
2016-11-03 13:13:36 -07:00
Eric Holscher
66fd939395
Add a bit more error handling.
2016-11-03 13:13:36 -07:00
Eric Holscher
624eeff030
Break out toctree into separate file.
...
Also add lots of docstrings,
so hopefully someone can understand this some day.
2016-11-03 13:13:36 -07:00
Eric Holscher
cc41787b58
Write up a more descriptive docstring
2016-11-03 13:13:36 -07:00
Eric Holscher
b6dc3d23d8
Clean up auto-tocing
2016-11-03 13:13:36 -07:00
Eric Holscher
4eefb01759
Build initial toctree implementation
2016-11-03 13:13:36 -07:00
Eric Holscher
6ff30f7d14
Merge pull request #88 from rtfd/fix-nested-directive
...
Revert attempt at making a hidden title
2016-11-03 13:12:59 -07:00
Anthony Johnson
2bff9e45b7
Revert attempt at making a hidden title
...
This directive was to remove the initial title from the nest block
2016-11-02 20:01:21 -07:00
Anthony
76c458f85f
Merge pull request #78 from rtfd/python-upgrades
...
Start using pydocstyle for Python doc generation
2016-11-02 20:00:09 -07:00
Eric Holscher
97e84f2e40
Merge pull request #86 from rtfd/pydocstyle-improvements
...
Improvements to pydocstyle Python parsing
2016-11-02 18:46:17 -07:00
Anthony Johnson
809c27ac6d
Lint fixes
2016-11-02 16:45:41 -07:00
Anthony Johnson
f607d5e1db
Improvements to pydocstyle Python parsing
...
* Moves relative path parsing away from the base mapper implementation
* Change argument parsing from splitting first line of source with ',' to use
AST traversal instead. This is not complete, but mostly PoC for now. Full
traversal into argument type nodes will allow us to get nested dict() etc.
We should open a ticket to track this work
* Cleans up some of the templates to reduce duplicate titles
* Adds a directive for nesting rST from constructs that might have headings.
Remove the first heading in this case to address the case where a module has a
docstring with a heading up front
* Adds tests
* Replaces example module with module that has more failing cases of parsing
Closes #78
Fixes #80
Fixes #81
Fixes #82
Fixes #83
Fixes #84
Fixes #85
2016-11-02 16:29:28 -07:00
Anthony Johnson
04805b5044
Fix version number
...
The module is actually 0.4 release currently. This is not a new release however,
so updated to match 0.4, no additional increment necessary yet.
2016-10-25 16:30:59 -07:00
Anthony Johnson
de56f25fe5
Add ignore for rope
2016-10-25 16:28:36 -07:00
Anthony Johnson
18ed62b0b2
Stop using requirements.txt
...
sphinx-autoapi is redistributable, we should be using setup.py for all of our
dependency management, not continuing to split off things into requirements.
Included a shortcut in the requirements for installing tox (the only dev requirement)
and the package in develop.
2016-10-25 16:28:12 -07:00
