Commit Graph

83 Commits (7dd822eef4fef4636cc0744340326e40e49e7550)

Author SHA1 Message Date
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 4ac85dd7af Added autoapi directives for Python 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 67dc008546 Added test for assignment to global containers 6 years ago
Sam Lai 974bae1f20 Support specifying package directories in `autoapi_dirs` (#135)
* Support specifying package directories as well

Fixes #108.

* Use os.sep instead of the hardcoded '/'

This was making the tests fail on Windows because the necessary '/'
replacements were not happening on Windows due to os.sep being '\\'.
6 years ago
Ashley Whetter 6ca62f16c9 Can control how __init__ docstring is displayed 6 years ago
Ashley Whetter b19b9ea28b Extended ast parsing with astroid 6 years ago
Ashley Whetter 87baee8998 Added integration tests for napoleon conversions 7 years ago
Ashley Whetter 4adcdc5351 Python documentation is now hierarchical 7 years ago
Ashley Whetter 174e6b8232 Fixed tests under Python 3 7 years ago
Ashley Whetter a1a3f05202 Fix for Sphinx 1.6 7 years ago
Anthony Johnson 2603729925
Fix some more parsing issues 7 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
7 years ago
Eric Holscher 875d6b6ffa Fix tests 8 years ago
Eric Holscher 215dd06e0a Add basic test for TOC Tree insertion 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 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
Anthony Johnson 20a1852907 Fix outdated fixture data 8 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
8 years ago
Anthony Johnson d30fa32762 Add configurable url prefix 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 2fd908e2a7 Fix test 9 years ago
Anthony Johnson af5bb7daeb Fix some escaping issues with transformed XML content
Fixes #38
9 years ago
Eric Holscher 4de4b376ca Rename `autoapi_dir` to `autoapi_dirs` to support multiple 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
Anthony Johnson 9dbd2f78dd Fix os path separator 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
Anthony Johnson 436eb28d9f Parse out doc id prefixes and add reference types 9 years ago
Anthony Johnson 9676bd011c Doc comment parsing and some optimizations to regex substitutions and patterns
Relies on regex replace and multiple replacement substitions, rather than
iterating over the pattern and applying logic to the found patterns.

Handles:

 * see & seealso - creates a reference link
 * paramref & typepararef - we can't reference params in sphinx, so this just
   replaces with bold text
9 years ago
Eric Holscher 220599c22f Attempt to fix path names on Windows. 9 years ago
Eric Holscher a067576144 Embed functions inside test 9 years ago
Eric Holscher 8cd9ae16b3 Small readme update 9 years ago
Eric Holscher d3b6bd305f Skip epyparse tests on py3 9 years ago
Eric Holscher acef865e6f Fix up python 3 support.
This works for everything except epyparse currently.
9 years ago
Eric Holscher 2152ae373b Add support for optionally raising error. 9 years ago
Eric Holscher 26b406fbab Don't keep files 9 years ago
Eric Holscher 2c823fd4e8 Add proper testing config 9 years ago
Eric Holscher 49897f091c Make sure example repo exists 9 years ago
Eric Holscher ba632296a6 Fix .NET 9 years ago
Eric Holscher 801e2e4675 Fix mock 9 years ago
Eric Holscher afe5190bc8 Fix README to include proper command 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 d2e0bdb6f0 Still point at mvc 9 years ago
Eric Holscher 03eb110d1c Remove outdated test deps from dotnet 9 years ago
Eric Holscher cb28412dfd Fix test mocks 9 years ago
Eric Holscher 136bb7c986 Small conf changes 9 years ago
Eric Holscher 30e4847898 Add basic tests & small output changes for auto-adding TOCTree 9 years ago
Eric Holscher d0621199c8 Mock the subprocess call for .Net 9 years ago