Commit Graph

95 Commits (958fe10103d30342625122c1f5d89c29bd7ee548)

Author SHA1 Message Date
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
Eric Holscher 21a82718ab Fix linting 7 years ago
Eric Holscher 8c1016f8c7 Fix linting 7 years ago
Eric Holscher 0e3e5df437 Fix linting 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
Anthony 152ea1a521 Merge pull request #104 from rtfd/python-ast
Start altering the pydocstyle AST parser for our needs
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 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 d34af13767 Fix pathing 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 c3db6e5bc8 Python 3 fixes 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
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
Eric Holscher 5e18b65a6c Lots of updates to handle file pathing more sanely. 8 years ago
Eric Holscher b24293e545 Start using pydocstyle for Python doc generation 8 years ago
Anthony Johnson 216d0e824b Doc updates 8 years ago
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
8 years ago
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
8 years ago
Anthony Johnson 4fef4ab2c1 Complete statement 9 years ago
Anthony Johnson 49af2b252a Update reference resolver for nested resolution 9 years ago
Anthony Johnson b6b1bb0f8b Fix missing key issue 9 years ago
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
9 years ago
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
9 years ago
Anthony Johnson a672d55187 Lint fix 9 years ago
Anthony Johnson bcee7eb22a Use autoapi_root for url root configuration 9 years ago
Anthony Johnson 61db34a4d6 Move include path to base object 9 years ago
Anthony Johnson d30fa32762 Add configurable url prefix 9 years ago
Anthony Johnson 93869e4ad6 Deconstruct pathname on object 9 years ago
Anthony Johnson 3fd930f4fb Try it again 9 years ago
Anthony Johnson 5fa272ca4b Fix template path issue on windows, fixes #37 9 years ago
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.
9 years ago
Anthony Johnson af5bb7daeb Fix some escaping issues with transformed XML content
Fixes #38
9 years ago
Eric Holscher 2958bc34fb Fix linting errors 9 years ago
Eric Holscher 4de4b376ca Rename `autoapi_dir` to `autoapi_dirs` to support multiple 9 years ago
Anthony Johnson c645cc18c0 Fix env passed to command, drop docfx.cmd detection 9 years ago
Anthony Johnson 47fbd54623 Drop shell subprocess execution 9 years ago