Commit Graph

94 Commits

Author SHA1 Message Date
Ashley Whetter
8d4fb4b1c3 Can document a public python API
Closes #153
2018-08-13 12:18:56 -07:00
Ashley Whetter
c3ef72ee14 Fixed nested classes not getting displayed in autogenerated docs 2018-08-07 14:39:38 -07:00
Ashley Whetter
7dd822eef4 Can still link to public items in private modules 2018-08-06 15:02:01 -07:00
Ashley Whetter
75ebcfc903 private-members also controls private subpackages and submodules
Closes #150
2018-08-06 14:52:42 -07:00
Ashley Whetter
4edf45af35 Added support for static and class methods 2018-08-06 14:19:12 -07:00
Ashley Whetter
9cb2f7d50e Methods include self in their arguments
autodoc does this by default so it makes sense to do it in autoapi also.
2018-08-06 14:19:12 -07:00
Ashley Whetter
d8f4847a5c
Added support for detecting Python exceptions (#147)
Closes #145
2018-07-31 16:57:24 -07:00
Ashley Whetter
6b8ccf62ae Fixed filtered classes and attributes getting displayed 2018-07-24 12:05:57 -07:00
Ashley Whetter
f2d3352801 Fixed incorrect display of long lists
Stop pretty printing because the annotation option cannot accept
multiline strings.
2018-07-16 12:45:17 -07:00
Ashley Whetter
b19b9ea28b Extended ast parsing with astroid 2018-05-08 22:41:35 -07:00
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
Eric Holscher
86a4de1668 Don’t show modules with no content. 2017-06-29 10:45:54 -07:00
Eric Holscher
3233bc0ac7 Fix templates to nest functions and use short names 2017-06-27 17:12:17 -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
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
b6dc3d23d8 Clean up auto-tocing 2016-11-03 13:13:36 -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
Eric Holscher
3aa1747795 Template updates. 2016-08-25 16:23:48 -07:00
Eric Holscher
b24293e545 Start using pydocstyle for Python doc generation 2016-06-09 15:44:30 -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
Daniel Roth
e51480d747 Fix indentation of code examples for properties. 2016-06-02 13:58:26 -07:00
Eric Holscher
58cb1ee64d Merge pull request #72 from rtfd/net-detail-cleanup
Clean up .NET detail page, add assemblies list
2016-05-02 07:36:48 -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
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.
2016-05-01 19:27:20 -07:00
Eric Holscher
72a888edde Merge pull request #67 from rtfd/dotnet-code-example-indent
Fix indentation on code block in .NET template
2016-03-30 23:28:39 -07:00
Anthony Johnson
04726106d2 Fix indentation on code block in .NET template 2016-03-25 17:39:00 -07:00
Anthony Johnson
49af2b252a Update reference resolver for nested resolution 2016-03-04 10:05:21 -08:00
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.
2016-01-12 16:33:34 -08: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
87a16ea421 Use more proper slugging on filenames for object
This resolves some issues with special characters in paths on Windows based
systems. It replaces special characters and unicode characters to ensure paths
are predictable.
2015-08-18 18:10:25 -07:00
Eric Holscher
095b1e5b29 Add Indentity as the default dotnet testing project.
Also lots of little cleanup to remove errors on those builds.
2015-07-20 14:48:25 -07:00
Eric Holscher
51fe162fb0 Cleanup to address review 2015-06-21 23:03:45 -04:00
Eric Holscher
4e9f1c02ea More small dotnet cleanup 2015-06-21 22:58:29 -04:00
Eric Holscher
5d861d13d8 Clean up handling of python args/params. 2015-06-10 14:37:17 -07:00
Eric Holscher
f60b7d8880 Add ability to configure options of display of objects. 2015-06-10 13:58:52 -07:00
Eric Holscher
bdae9f083c Add ability to hide undocumented methods, etc. 2015-06-10 13:33:42 -07:00
Eric Holscher
1cde5590eb Clean up how we render templates.
* Add top_level_object as global concept.
* Fix toctree generation
* Add passing of options to rendering
2015-06-10 13:13:34 -07:00
Eric Holscher
5ca2ee76a5 Refactor into nicer top-level interface to the Domains.
Languages refactored:

* Python
* JS
2015-06-06 16:11:49 -07:00
Eric Holscher
9bc6072283 Add initial javascript support with jsdoc 3. 2015-06-06 13:08:44 -07:00
Anthony Johnson
481bd777cb Fix spacing on parameter output and code blocks 2015-06-01 11:26:19 -07:00
Anthony Johnson
c270b9de14 Move parameter name list up to signature 2015-05-31 14:38:17 -07:00
Anthony Johnson
181c7ea2a4 Add child display 2015-05-30 18:42:06 -07:00
Anthony Johnson
808c1a090f Add parameters to output 2015-05-30 18:32:43 -07:00