Ashley Whetter
4adcdc5351
Python documentation is now hierarchical
7 years ago
Ashley Whetter
b5be7b6d9a
Fixed a warning
7 years ago
Ashley Whetter
958fe10103
Added autoapisummary directive
7 years ago
Ashley Whetter
5a86878811
Fixed Python subpackages having incomplete names
7 years ago
Eric Holscher
e5cce2c7dd
Fix lint
7 years ago
Eric Holscher
d803b28d00
Kill janky napolean overlay
7 years ago
Eric Holscher
3531f5560a
Merge remote-tracking branch 'origin/master' into cleanup-june
7 years ago
Ashley Whetter
86a9ffdd60
Fixed lint errors
7 years ago
Ashley Whetter
ae1e4f556d
Fixed usage of deprecated status_indicator
...
This fixes a compatibiity issue with Sphinx 1.7
7 years ago
Ashley Whetter
a1a3f05202
Fix for Sphinx 1.6
7 years ago
Eric Holscher
3875cf495d
Fix noting the toctree
7 years ago
Eric Holscher
21a82718ab
Fix linting
7 years ago
Eric Holscher
8c1016f8c7
Fix linting
7 years ago
Eric Holscher
ed57a216ec
Fix lint
7 years ago
Eric Holscher
0e3e5df437
Fix linting
7 years ago
Eric Holscher
86a4de1668
Don’t show modules with no content.
7 years ago
Eric Holscher
4428ecd6e8
Add ability to process Napolean docstrings.
7 years ago
Eric Holscher
efb541f78a
Add ability to add API to top-level TOC.
7 years ago
Eric Holscher
3233bc0ac7
Fix templates to nest functions and use short names
7 years ago
Anthony
152ea1a521
Merge pull request #104 from rtfd/python-ast
...
Start altering the pydocstyle AST parser for our needs
8 years ago
Anthony
e7a624254a
Merge pull request #106 from rtfd/fix-argument-call
...
Fix Python argument parsing for Call nodes
8 years ago
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.
8 years ago
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.
8 years ago
Anthony Johnson
2603729925
Fix some more parsing issues
8 years ago
Anthony Johnson
0faeb500ee
More fixes
8 years ago
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
8 years ago
Eric Holscher
426d677324
Fix review feedback
8 years ago
Eric Holscher
d7e8e13613
Don't use string
8 years ago
Eric Holscher
6024223d9e
Add fix to version checking on <1.5
8 years ago
Ashley Whetter
a9521553d9
Fix for Sphinx 1.5
8 years ago
Eric Holscher
d34af13767
Fix pathing
8 years ago
Eric Holscher
e8514dfee2
Use shortname for methods
8 years ago
Eric Holscher
5901291d3f
Remove nested parse
8 years ago
Eric Holscher
491f8c9065
Keep nested-parse
8 years ago
Eric Holscher
aa06999300
Nest the wrapper
8 years ago
Eric Holscher
ffb2130b55
Implement prepare_docstring filter that wraps Sphinx's
...
This allows us to output docstrings in a reasonable fashion.
8 years ago
Eric Holscher
c557182525
Fix review feedback
8 years ago
Eric Holscher
73324fab7e
Remove unneeded index entry
8 years ago
Eric Holscher
c3db6e5bc8
Python 3 fixes
8 years ago
Eric Holscher
66fd939395
Add a bit more error handling.
8 years ago
Eric Holscher
624eeff030
Break out toctree into separate file.
...
Also add lots of docstrings,
so hopefully someone can understand this some day.
8 years ago
Eric Holscher
cc41787b58
Write up a more descriptive docstring
8 years ago
Eric Holscher
b6dc3d23d8
Clean up auto-tocing
8 years ago
Eric Holscher
4eefb01759
Build initial toctree implementation
8 years ago
Anthony Johnson
2bff9e45b7
Revert attempt at making a hidden title
...
This directive was to remove the initial title from the nest block
8 years ago
Anthony Johnson
809c27ac6d
Lint fixes
8 years ago
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
8 years ago
Anthony Johnson
fbe58022c5
Drop __repr__ method on python mapper
...
We aren't using this pattern in the other mappers. Something we could add, but
out of scope here.
8 years ago
Anthony Johnson
a5a34df7f4
Basic cleanup on docstrings, import order
8 years ago
Eric Holscher
8e97201423
A few more PYthon upgrades
8 years ago