Commit Graph

108 Commits (827297433ae3047cd5c86eb3a1f768d6fb609682)

Author SHA1 Message Date
lhfriedman c51fb3f737 added scoped keywords
see issue 213 (https://github.com/readthedocs/sphinx-autoapi/issues/213)
4 years ago
Ashley Whetter ea150af1da Fixed incorrect formatting with private inheritance diagrams
Fixes #195
4 years ago
Ashley Whetter 4ba45cfacb Can document inherited members
Closes #183
4 years ago
Ashley Whetter c5d5fb5346 Made passing of options to templates more sane 4 years ago
Ashley Whetter 265b4ae562 Added show-inheritance
Also turned autoapi_include_inheritance_graphs into a
show-inheritance-diagram AutoAPI option to be more consistent
with show-inheritance.

Partially implements #183
4 years ago
Ashley Whetter 076427e6ae Added inheritance diagrams support
Close #140
5 years ago
Ashley Whetter d40122948b Remaining rtfd -> readthedocs replacements 5 years ago
Armand BENETEAU fa3b0b3f70 Fix Go documentation generation (#172)
* Correction of the "parameters" accessibility problem in the Go mapper

The "parameters" attributes of the GoPythonMapper class instance was
not accessible from the "output_rst" function used to create the .rst
file. Thanks to this correction, the parameters are now accessible.

* Enhance the template used to genertae the .rst file from the .go source file

This modification allows to create a .rst file compatible with the
last version of Sphinx. Without this correction, the creation of documentation
was not possible. A "make html" command lead to an "AssertionError" Exception.
5 years ago
Ashley Whetter 46c577eda1 Support for async and other Sphinx 2.1 method directive options 5 years ago
Ashley Whetter 589826e90c Can override ignoring local imports in modules by using __all__ 5 years ago
Ashley Whetter 9d45eed4d0 Fixed incorrect formatting of functions and methods 5 years ago
Ashley Whetter b90284f0fe Support basic type annotations
Closes #139
5 years ago
Ashley Whetter 3b299be332 Tidied up index page 5 years ago
Ashley Whetter a4f798183c Fixed private submodules displaying when private-members turned off
Also fixed whitespace issues in templates.
5 years ago
Ashley Whetter 8d4fb4b1c3 Can document a public python API
Closes #153
6 years ago
Ashley Whetter c3ef72ee14 Fixed nested classes not getting displayed in autogenerated docs 6 years ago
Ashley Whetter 7dd822eef4 Can still link to public items in private modules 6 years ago
Ashley Whetter 75ebcfc903 private-members also controls private subpackages and submodules
Closes #150
6 years ago
Ashley Whetter 4edf45af35 Added support for static and class methods 6 years ago
Ashley Whetter 9cb2f7d50e Methods include self in their arguments
autodoc does this by default so it makes sense to do it in autoapi also.
6 years ago
Ashley Whetter d8f4847a5c
Added support for detecting Python exceptions (#147)
Closes #145
6 years ago
Ashley Whetter 6b8ccf62ae Fixed filtered classes and attributes getting displayed 6 years ago
Ashley Whetter f2d3352801 Fixed incorrect display of long lists
Stop pretty printing because the annotation option cannot accept
multiline strings.
6 years ago
Ashley Whetter b19b9ea28b Extended ast parsing with astroid 6 years ago
Anthony ae1c6276df
Merge pull request #116 from AWhetter/py_hierarchy
Py hierarchy
7 years ago
Ashley Whetter 7b3e6fca6d Added basic class signature discovery 7 years ago
Ashley Whetter b792463cc9 Can turn off autoapisummary directives in output 7 years ago
Ashley Whetter 4adcdc5351 Python documentation is now hierarchical 7 years ago
Ashley Whetter 958fe10103 Added autoapisummary directive 7 years ago
Eric Holscher 86a4de1668 Don’t show modules with no content. 7 years ago
Eric Holscher 3233bc0ac7 Fix templates to nest functions and use short names 7 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 ffb2130b55 Implement prepare_docstring filter that wraps Sphinx's
This allows us to output docstrings in a reasonable fashion.
8 years ago
Eric Holscher b6dc3d23d8 Clean up auto-tocing 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
Eric Holscher 3aa1747795 Template updates. 8 years ago
Eric Holscher b24293e545 Start using pydocstyle for Python doc generation 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
Daniel Roth e51480d747 Fix indentation of code examples for properties. 8 years ago
Eric Holscher 58cb1ee64d Merge pull request #72 from rtfd/net-detail-cleanup
Clean up .NET detail page, add assemblies list
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 4e2d5ccdfb Use short name for reference link name
As the parent block is a namespace declaration, we can use nesting to imply the
namespace. This removes the namespace from the object name and matches what we
do on other pages.
8 years ago
Eric Holscher 72a888edde Merge pull request #67 from rtfd/dotnet-code-example-indent
Fix indentation on code block in .NET template
8 years ago
Anthony Johnson 04726106d2 Fix indentation on code block in .NET template 8 years ago
Anthony Johnson 49af2b252a Update reference resolver for nested resolution 8 years ago
Anthony Johnson 598f449b8e Format definition lists correctly
If the construct is missing documentation, it broke defnition list styling. This
inserts a placeholder comment to avoid that.
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