Commit Graph

186 Commits (cc41787b58e1f6a6c551236023b1f84006d8a491)

Author SHA1 Message Date
Eric Holscher cc41787b58 Write up a more descriptive docstring 8 years ago
Eric Holscher b6dc3d23d8 Clean up auto-tocing 8 years ago
Eric Holscher 4eefb01759 Build initial toctree implementation 8 years ago
Anthony Johnson 2bff9e45b7 Revert attempt at making a hidden title
This directive was to remove the initial title from the nest block
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 3aa1747795 Template updates. 8 years ago
Eric Holscher 6025db45a7 Clean up how we handle file suffix. 8 years ago
Eric Holscher b24293e545 Start using pydocstyle for Python doc generation 8 years ago
Anthony Johnson fab86cbc66 Revert basestring -> str in check for autoapi_dirs
Not sure we need to be concerned about byte strings here either way.

Fixes #74
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
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
Eric Holscher 92ef8f60db Merge pull request #71 from rtfd/list-remove-namespace
Use short name for reference link name
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
Anthony Johnson 11ad556d3e Handle string input for api dir
This was iterating over the settings assuming it was a list. We handle this as a
list in some instances, and recommend using a string in others. Just handle
both.
8 years ago
Anthony 26924f93e3 Merge pull request #54 from danroth27/patch-1
Update extension.py to handle absolute paths
9 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 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
Daniel Roth ca3a002aa6 Update extension.py to handle absolute paths 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 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 3dfd9ac47f Fix error 9 years ago
Eric Holscher 81d4568713 Merge pull request #35 from rtfd/support-multiple-source-dirs
Rename `autoapi_dir` to `autoapi_dirs` to support multiple source dirs
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
Daniel Roth 180c1bb36b Update extension.py
Missing an 's'
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
Anthony Johnson 9b75431e6e Configure docfx command by system 9 years ago
Eric Holscher 3a22ae63e0 Merge pull request #23 from rtfd/doc-name-slugging
Use more proper slugging on filenames for object
9 years ago