Commit Graph

80 Commits (958fe10103d30342625122c1f5d89c29bd7ee548)

Author SHA1 Message Date
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
9 years ago
Anthony Johnson 04726106d2 Fix indentation on code block in .NET template 9 years ago
Anthony Johnson 49af2b252a Update reference resolver for nested resolution 9 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
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.
9 years ago
Eric Holscher 095b1e5b29 Add Indentity as the default dotnet testing project.
Also lots of little cleanup to remove errors on those builds.
9 years ago
Eric Holscher 51fe162fb0 Cleanup to address review 9 years ago
Eric Holscher 4e9f1c02ea More small dotnet cleanup 9 years ago
Eric Holscher 5d861d13d8 Clean up handling of python args/params. 9 years ago
Eric Holscher f60b7d8880 Add ability to configure options of display of objects. 9 years ago
Eric Holscher bdae9f083c Add ability to hide undocumented methods, etc. 9 years ago
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
9 years ago
Eric Holscher 5ca2ee76a5 Refactor into nicer top-level interface to the Domains.
Languages refactored:

* Python
* JS
9 years ago
Eric Holscher 9bc6072283 Add initial javascript support with jsdoc 3. 9 years ago
Anthony Johnson 481bd777cb Fix spacing on parameter output and code blocks 9 years ago
Anthony Johnson c270b9de14 Move parameter name list up to signature 9 years ago
Anthony Johnson 181c7ea2a4 Add child display 9 years ago
Anthony Johnson 808c1a090f Add parameters to output 9 years ago
Anthony Johnson 8819b46a2f Clean up cruft and handle a few failures better 9 years ago
Anthony Johnson 3653636673 Revert "Fix package output for now."
With better formatting of domain output, separation by heading is redundant.
Also, secondary header for page title might not be necessary with correct domain
output of package objects.
9 years ago
Eric Holscher f133c7d603 Fix package output for now. 9 years ago
Eric Holscher 18533426c3 Add title to package 9 years ago
Eric Holscher cdd8d244de Fix up templates 9 years ago
Eric Holscher a4a68d9213 Fix up go stuff 9 years ago
Anthony Johnson af539d8868 Untested first pass of templates 9 years ago
Anthony Johnson 9612dae694 Add better reference and obj id handling for generics 10 years ago
Anthony Johnson a3cea299dc Adding indentation on .net detail template, hidden types 10 years ago
Eric Holscher a05a85507a Add GitHub section 10 years ago
Eric Holscher 6410bee011 Fix hierarchy, and include object itself in it. 10 years ago
Eric Holscher c79a0f3cee Clean up namespaces and display 10 years ago
Eric Holscher a4b116b527 Move to top-level TOC for now. 10 years ago
Eric Holscher cc8e5d6ee5 Show local TOC 10 years ago