Commit Graph

99 Commits

Author SHA1 Message Date
Anthony
ae1c6276df
Merge pull request #116 from AWhetter/py_hierarchy
Py hierarchy
2017-11-09 16:24:09 -07:00
Ashley Whetter
7b3e6fca6d Added basic class signature discovery 2017-11-09 14:18:11 -08:00
Ashley Whetter
b792463cc9 Can turn off autoapisummary directives in output 2017-11-09 12:48:21 -08:00
Ashley Whetter
4adcdc5351 Python documentation is now hierarchical 2017-11-09 12:48:21 -08:00
Ashley Whetter
958fe10103 Added autoapisummary directive 2017-11-09 12:21:52 -08:00
Ashley Whetter
5a86878811 Fixed Python subpackages having incomplete names 2017-11-09 11:54:16 -08:00
Eric Holscher
e5cce2c7dd Fix lint 2017-11-09 10:56:42 -07:00
Eric Holscher
d803b28d00 Kill janky napolean overlay 2017-11-09 10:54:20 -07:00
Eric Holscher
3531f5560a Merge remote-tracking branch 'origin/master' into cleanup-june 2017-11-09 10:51:24 -07:00
Ashley Whetter
86a9ffdd60 Fixed lint errors 2017-11-08 16:04:25 -08:00
Ashley Whetter
ae1e4f556d Fixed usage of deprecated status_indicator
This fixes a compatibiity issue with Sphinx 1.7
2017-11-05 15:11:06 -08:00
Eric Holscher
21a82718ab Fix linting 2017-06-29 14:48:06 -07:00
Eric Holscher
8c1016f8c7 Fix linting 2017-06-29 14:37:59 -07:00
Eric Holscher
0e3e5df437 Fix linting 2017-06-29 10:57:38 -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
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 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
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
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
d34af13767 Fix pathing 2016-11-04 20:50:05 -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
c3db6e5bc8 Python 3 fixes 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
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
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.
2016-10-25 16:27:05 -07:00
Anthony Johnson
a5a34df7f4 Basic cleanup on docstrings, import order 2016-10-25 16:26:30 -07:00
Eric Holscher
8e97201423 A few more PYthon upgrades 2016-10-20 14:57:07 -07:00
Eric Holscher
5e18b65a6c Lots of updates to handle file pathing more sanely. 2016-08-25 16:25:38 -07:00
Eric Holscher
b24293e545 Start using pydocstyle for Python doc generation 2016-06-09 15:44:30 -07:00
Anthony Johnson
216d0e824b Doc updates 2016-06-02 18:03:54 -07:00
Anthony Johnson
5c07b6cbc5 Make docfx great again!
This updates some small outdated pieces with docfx integration:

* Support docfx.json first, if no patterns were explicitly specified
* Refactor output path, use new _api path
* Add missing operator type to .net parsing and template output
* Fix indent issue with code samples
* Add docs on how to actually use docfx + autoapi

Fixes #45
Fixes #46
Fixes #48
2016-06-02 17:24:31 -07:00
Anthony Johnson
1c6c9f15d8 Clean up .NET detail page, add assemblies list
The .NET detail page was slightly messy, this cleans up and settles on some UX
there:

* Don't use an explicit header for summary, move it up under the object heading
* Drop redundant (and broken) github edit link on page, we need to fix the
  github header link instead.
* Add pattern for displaying read only fields in definition list
* Adds namespace + assemblies listing to detail page

Refs #60
2016-05-01 19:57:58 -07:00
Anthony Johnson
4fef4ab2c1 Complete statement 2016-03-04 10:49:01 -08:00
Anthony Johnson
49af2b252a Update reference resolver for nested resolution 2016-03-04 10:05:21 -08:00
Anthony Johnson
b6b1bb0f8b Fix missing key issue 2016-02-26 15:13:05 -08:00
Anthony Johnson
66dcf1fcaa Add resolution to spec identifiers using docfx references
This uses the docfx output references to resolve the spec identifier to a human
friendly name. The linking still requires full reference resolution however.

Refs #58
2016-02-25 14:35:09 -08:00
Anthony Johnson
019f064f36 Fix parsing issues with code comment XML
* paramref surrounding characters were not handled
* multiple paramrefs weren't parsed out
* uses correct return field

* Fixes #55
* Fixes #56
2016-02-25 11:46:56 -08:00
Anthony Johnson
a672d55187 Lint fix 2016-01-12 16:33:10 -08:00
Anthony Johnson
bcee7eb22a Use autoapi_root for url root configuration 2015-10-28 11:04:23 -07:00
Anthony Johnson
61db34a4d6 Move include path to base object 2015-10-27 11:35:44 -07:00
Anthony Johnson
d30fa32762 Add configurable url prefix 2015-10-27 11:35:44 -07:00
Anthony Johnson
93869e4ad6 Deconstruct pathname on object 2015-10-27 11:34:54 -07:00
Anthony Johnson
3fd930f4fb Try it again 2015-10-27 11:34:54 -07:00
Anthony Johnson
5fa272ca4b Fix template path issue on windows, fixes #37 2015-10-27 11:34:54 -07:00
Anthony Johnson
1688b53f42 Replace non-existant :dn:ref: reference with :any: for now
This will resolve more lookups as proper references, not anchor links. The :any:
lookup is strict though, the domain should implement it's own :dn:obj: generic
lookup.
2015-10-27 01:12:25 -07:00
Anthony Johnson
af5bb7daeb Fix some escaping issues with transformed XML content
Fixes #38
2015-10-27 00:46:59 -07:00