92b4ea9dc8
Fixed linking to builtin bases
6 years ago
616267726b
No longer document __init__ attributes without a docstring
...
Fixes #146
Also fixed duplicates when a property is set in __init__.
6 years ago
8d4fb4b1c3
Can document a public python API
...
Closes #153
6 years ago
9e9c28e15b
Can opt to write manual documentation
6 years ago
b789dcaa73
Fixed autodoc being unable to discover nested classes
6 years ago
c3ef72ee14
Fixed nested classes not getting displayed in autogenerated docs
6 years ago
8a965bb15a
Fixed lint error
6 years ago
bc65e766c3
Made it easier to remove default index page
...
Also removed autoapi_add_api_root_toctree config option
because it is less useful now.
Closes #152
6 years ago
7dd822eef4
Can still link to public items in private modules
6 years ago
75ebcfc903
private-members also controls private subpackages and submodules
...
Closes #150
6 years ago
6ffec93569
Fixed lint errors
6 years ago
4ac85dd7af
Added autoapi directives for Python
6 years ago
4edf45af35
Added support for static and class methods
6 years ago
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
af4263457e
Full path is resolved for bases from same module
6 years ago
a1825cd98d
Fixed astroid 2.0 compatibility
...
Closes #148
6 years ago
d8f4847a5c
Added support for detecting Python exceptions ( #147 )
...
Closes #145
6 years ago
6b8ccf62ae
Fixed filtered classes and attributes getting displayed
6 years ago
f2d3352801
Fixed incorrect display of long lists
...
Stop pretty printing because the annotation option cannot accept
multiline strings.
6 years ago
9dd26fd32b
Fixed running incorrect jsdoc command on Windows
...
Issue #125 .
jsdoc on windows is deployed as jsdoc.cmd
6 years ago
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
ea6f1d322e
Fix lint errors
6 years ago
6ca62f16c9
Can control how __init__ docstring is displayed
6 years ago
6eb18467f7
Fixed undoc members logic
6 years ago
9f6f7d0b5d
Added support for viewcode
6 years ago
741dfaffb3
Source files no longer need to be in sys.path
6 years ago
b19b9ea28b
Extended ast parsing with astroid
6 years ago
ea8efe91dc
Fix lint errors
...
There should be no behavioural changes - this is just explicitly returning what would've been returned anyway.
7 years ago
b06d4f801b
Started autoloading autosummary extension
7 years ago
5075467441
Formats napoleon docstrings in Python
7 years ago
ae1c6276df
Merge pull request #116 from AWhetter/py_hierarchy
...
Py hierarchy
7 years ago
7b3e6fca6d
Added basic class signature discovery
7 years ago
b792463cc9
Can turn off autoapisummary directives in output
7 years ago
4adcdc5351
Python documentation is now hierarchical
7 years ago
b5be7b6d9a
Fixed a warning
7 years ago
958fe10103
Added autoapisummary directive
7 years ago
5a86878811
Fixed Python subpackages having incomplete names
7 years ago
e5cce2c7dd
Fix lint
7 years ago
d803b28d00
Kill janky napolean overlay
7 years ago
3531f5560a
Merge remote-tracking branch 'origin/master' into cleanup-june
7 years ago
86a9ffdd60
Fixed lint errors
7 years ago
ae1e4f556d
Fixed usage of deprecated status_indicator
...
This fixes a compatibiity issue with Sphinx 1.7
7 years ago
a1a3f05202
Fix for Sphinx 1.6
7 years ago
3875cf495d
Fix noting the toctree
7 years ago
21a82718ab
Fix linting
7 years ago
8c1016f8c7
Fix linting
7 years ago
ed57a216ec
Fix lint
7 years ago
0e3e5df437
Fix linting
7 years ago
86a4de1668
Don’t show modules with no content.
7 years ago
4428ecd6e8
Add ability to process Napolean docstrings.
7 years ago
efb541f78a
Add ability to add API to top-level TOC.
7 years ago
3233bc0ac7
Fix templates to nest functions and use short names
7 years ago
152ea1a521
Merge pull request #104 from rtfd/python-ast
...
Start altering the pydocstyle AST parser for our needs
8 years ago
e7a624254a
Merge pull request #106 from rtfd/fix-argument-call
...
Fix Python argument parsing for Call nodes
8 years ago
715b6662e5
Fix Python argument parsing for Call nodes
...
This previous was throwing exceptions in some cases where Attribute nodes were
used instead of Name nodes.
8 years ago
df74247128
Allow for toplevel module as Sphinx extension
...
Instead of requiring:
extensions = ['autoapi.extension']
This allows for the toplevel:
extensions = ['autoapi']
This is more intuitive for users, as extension is an internal concept.
8 years ago
2603729925
Fix some more parsing issues
8 years ago
0faeb500ee
More fixes
8 years ago
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
8 years ago
426d677324
Fix review feedback
8 years ago
d7e8e13613
Don't use string
8 years ago
6024223d9e
Add fix to version checking on <1.5
8 years ago
a9521553d9
Fix for Sphinx 1.5
8 years ago
d34af13767
Fix pathing
8 years ago
e8514dfee2
Use shortname for methods
8 years ago
5901291d3f
Remove nested parse
8 years ago
491f8c9065
Keep nested-parse
8 years ago
aa06999300
Nest the wrapper
8 years ago
ffb2130b55
Implement prepare_docstring filter that wraps Sphinx's
...
This allows us to output docstrings in a reasonable fashion.
8 years ago
c557182525
Fix review feedback
8 years ago
73324fab7e
Remove unneeded index entry
8 years ago
c3db6e5bc8
Python 3 fixes
8 years ago
66fd939395
Add a bit more error handling.
8 years ago
624eeff030
Break out toctree into separate file.
...
Also add lots of docstrings,
so hopefully someone can understand this some day.
8 years ago
cc41787b58
Write up a more descriptive docstring
8 years ago
b6dc3d23d8
Clean up auto-tocing
8 years ago
4eefb01759
Build initial toctree implementation
8 years ago
2bff9e45b7
Revert attempt at making a hidden title
...
This directive was to remove the initial title from the nest block
8 years ago
809c27ac6d
Lint fixes
8 years ago
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
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
a5a34df7f4
Basic cleanup on docstrings, import order
8 years ago
8e97201423
A few more PYthon upgrades
8 years ago
5e18b65a6c
Lots of updates to handle file pathing more sanely.
8 years ago
3aa1747795
Template updates.
8 years ago
6025db45a7
Clean up how we handle file suffix.
8 years ago
b24293e545
Start using pydocstyle for Python doc generation
8 years ago
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
216d0e824b
Doc updates
8 years ago
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
e51480d747
Fix indentation of code examples for properties.
8 years ago
58cb1ee64d
Merge pull request #72 from rtfd/net-detail-cleanup
...
Clean up .NET detail page, add assemblies list
9 years ago
92ef8f60db
Merge pull request #71 from rtfd/list-remove-namespace
...
Use short name for reference link name
9 years ago
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
9 years ago
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.
9 years ago
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.
9 years ago
26924f93e3
Merge pull request #54 from danroth27/patch-1
...
Update extension.py to handle absolute paths
9 years ago
72a888edde
Merge pull request #67 from rtfd/dotnet-code-example-indent
...
Fix indentation on code block in .NET template
9 years ago
04726106d2
Fix indentation on code block in .NET template
9 years ago
4fef4ab2c1
Complete statement
9 years ago
Ashley Whetter
Ashley Whetter
Ashley Whetter
fredbi
Sam Lai
Sam Lai
Anthony
Eric Holscher
Daniel Roth