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.
6 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
7 years ago
e7a624254a
Merge pull request #106 from rtfd/fix-argument-call
...
Fix Python argument parsing for Call nodes
7 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.
7 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.
7 years ago
2603729925
Fix some more parsing issues
7 years ago
0faeb500ee
More fixes
7 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
7 years ago
426d677324
Fix review feedback
7 years ago
d7e8e13613
Don't use string
7 years ago
6024223d9e
Add fix to version checking on <1.5
7 years ago
a9521553d9
Fix for Sphinx 1.5
7 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
8 years ago
92ef8f60db
Merge pull request #71 from rtfd/list-remove-namespace
...
Use short name for reference link name
8 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
8 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.
8 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.
8 years ago
26924f93e3
Merge pull request #54 from danroth27/patch-1
...
Update extension.py to handle absolute paths
8 years ago
72a888edde
Merge pull request #67 from rtfd/dotnet-code-example-indent
...
Fix indentation on code block in .NET template
8 years ago
04726106d2
Fix indentation on code block in .NET template
8 years ago
4fef4ab2c1
Complete statement
8 years ago
49af2b252a
Update reference resolver for nested resolution
8 years ago
b6b1bb0f8b
Fix missing key issue
8 years ago
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
8 years ago
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
ca3a002aa6
Update extension.py to handle absolute paths
8 years ago
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
a672d55187
Lint fix
9 years ago
bcee7eb22a
Use autoapi_root for url root configuration
9 years ago
61db34a4d6
Move include path to base object
9 years ago
d30fa32762
Add configurable url prefix
9 years ago
93869e4ad6
Deconstruct pathname on object
9 years ago
3fd930f4fb
Try it again
9 years ago
5fa272ca4b
Fix template path issue on windows, fixes #37
9 years ago
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
af5bb7daeb
Fix some escaping issues with transformed XML content
...
Fixes #38
9 years ago
3dfd9ac47f
Fix error
9 years ago
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
2958bc34fb
Fix linting errors
9 years ago
4de4b376ca
Rename `autoapi_dir` to `autoapi_dirs` to support multiple
9 years ago
180c1bb36b
Update extension.py
...
Missing an 's'
9 years ago
c645cc18c0
Fix env passed to command, drop docfx.cmd detection
9 years ago
47fbd54623
Drop shell subprocess execution
9 years ago
9b75431e6e
Configure docfx command by system
9 years ago
3a22ae63e0
Merge pull request #23 from rtfd/doc-name-slugging
...
Use more proper slugging on filenames for object
9 years ago
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
436eb28d9f
Parse out doc id prefixes and add reference types
9 years ago
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
460aea6a8b
Stub out XML parsing
9 years ago
f8e1d7435c
Kill redefined ref_name
9 years ago
ee6a2ada3c
Use ref_name instead of hacking specific name
9 years ago
c14ae7e8f1
Fix linting
9 years ago
05d891915f
Kill wrong bash prefix
9 years ago
d4dd35a0e2
Merge pull request #20 from rtfd/appveyor
...
Add Windows builds
9 years ago
d1fdfa1526
Fix call to join
9 years ago
b66a83b550
Fix shell=True
9 years ago
dfbae94963
Handle empty objects list
9 years ago
243549f2fe
Add shell=True to the docfx call
9 years ago
3c89158662
Explicitly call bash for docfx
9 years ago
d7945ac5ba
Explicitly call bash for docfx
9 years ago
999a031108
Only open files for writing
9 years ago
220599c22f
Attempt to fix path names on Windows.
9 years ago
a21f88c806
Add comment
9 years ago
b4fdac80d3
Raise exception properly on Python 3
9 years ago
acef865e6f
Fix up python 3 support.
...
This works for everything except epyparse currently.
9 years ago
2152ae373b
Add support for optionally raising error.
9 years ago
f9d4d8c18d
Clean up tox file
9 years ago
0c1583ac40
Add proper exceptions
9 years ago
6a67c16642
Fix the last of the linting errors
9 years ago
e397229177
Be more defensive in deletes
9 years ago
e00fc127cc
Clean up errors caught by linting
9 years ago
d1d452a0a4
Add ability for per-mapper cleanup tasks.
9 years ago
118fa50e11
Fix circular import
9 years ago
095b1e5b29
Add Indentity as the default dotnet testing project.
...
Also lots of little cleanup to remove errors on those builds.
9 years ago
1df370b682
Don’t assume we have defaults for all types.
9 years ago
c81ab2873d
Add default ignore patterns.
9 years ago
82945f6068
Fix syntax parsing
9 years ago
0dd05ba0aa
Fix environment call for failing tests
9 years ago
e021fbea6c
Changes to support docfx
...
Note: This requires a patch on the docfx executable, the hashbang line is
missing, creating an execution failure
This makes the executed command docfx, instead of BuildMeta. It adds some error
checking and reporting to output as well.
This is a work in progress, the output format seems to have changed again.
9 years ago
481bf32b15
Match ignore patterns again full filename
9 years ago
2abc73ce30
Use proper passed in patterns
9 years ago
c20783558e
Add vbproj to dotnet default mapping
9 years ago
cb28412dfd
Fix test mocks
9 years ago
6f6e09b1f6
Properly handle multiple file patterns.
9 years ago
dac1ee0f2e
Properly look for substring
9 years ago
30e4847898
Add basic tests & small output changes for auto-adding TOCTree
9 years ago
ba1a09a8d1
Add ability to auto-inject AutoAPI into TocTree
9 years ago
1eb7f4c6fa
Merge branch 'master' of github.com:rtfd/sphinx-autoapi
9 years ago
9163a0088a
Catch TypeError in JS mapper.
9 years ago
19c79222a9
Refactor integration tests to use fixture data.
...
This removes dependence on real tooling.
The main downside is that it’s fragile to output changes in the tooling.
Not a lot we can do though,
other than have real integration tests, also.
9 years ago
63a7c499fc
Resort imports
9 years ago
51fe162fb0
Cleanup to address review
9 years ago
4e9f1c02ea
More small dotnet cleanup
9 years ago
463816673d
Small dotnet updates
9 years ago
8770a04bf8
Update dotnet codebase for new tooling
9 years ago
5d861d13d8
Clean up handling of python args/params.
9 years ago
685665535f
Rename files
9 years ago
f60b7d8880
Add ability to configure options of display of objects.
9 years ago
bdae9f083c
Add ability to hide undocumented methods, etc.
9 years ago
732942828f
Use ordered dicts for mapping.
9 years ago
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
4f6474440d
Add some docstrings
9 years ago
057100b1ee
Rename base objects to be more descriptive.
9 years ago
59add63ae4
Refactor DotNet Domain, and clean up tests.
9 years ago
0c1bcece23
Small domain cleanup
9 years ago
d0cb6ae6e0
Clean up AutoAPI output and naming
9 years ago
d424993e8c
Safer file writing
9 years ago
6c204dc570
Update go Domain and add basic Go test
9 years ago
a94e3d8c60
Clean up warnings and move jinja_env onto base
9 years ago
c02cd9d32e
Add testing for template overrides.
9 years ago
5ca2ee76a5
Refactor into nicer top-level interface to the Domains.
...
Languages refactored:
* Python
* JS
9 years ago
1d3bd2012e
Refactor some settings and jinja env.
9 years ago
9bc6072283
Add initial javascript support with jsdoc 3.
9 years ago
df6e952a51
Fix python calls to create_class
9 years ago
c3239118b0
Move base into domains directory.
9 years ago
426c3db619
Kill unused utils file.
9 years ago
3e5eaf2180
Merge branch 'go-support'
9 years ago
966cce1051
Default autoapi to python instead of dotnet
9 years ago
481bd777cb
Fix spacing on parameter output and code blocks
9 years ago
b56f2dc1d8
Merge remote-tracking branch 'origin/go-parsed-example'
9 years ago
c2fd90fd21
Fix handling of create_class as a generator
9 years ago
ff8292af6f
Clean up print statement
9 years ago
c270b9de14
Move parameter name list up to signature
9 years ago
f0772d1a57
Support inverted go const and var objects
...
Changes class creation to a generator and invert list of const/var names to
multiple objects.
9 years ago
181c7ea2a4
Add child display
9 years ago
808c1a090f
Add parameters to output
9 years ago
8819b46a2f
Clean up cruft and handle a few failures better
9 years ago
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
f133c7d603
Fix package output for now.
9 years ago
18533426c3
Add title to package
9 years ago
cdd8d244de
Fix up templates
9 years ago
a4a68d9213
Fix up go stuff
9 years ago
9bdd44d8cd
Add a basic go domain.
9 years ago
af539d8868
Untested first pass of templates
9 years ago
0ccde8454a
Fix double autoapi_dir prepended to find_files
9 years ago
9612dae694
Add better reference and obj id handling for generics
9 years ago
a3cea299dc
Adding indentation on .net detail template, hidden types
9 years ago
a05a85507a
Add GitHub section
9 years ago
6410bee011
Fix hierarchy, and include object itself in it.
9 years ago
c79a0f3cee
Clean up namespaces and display
9 years ago
4e532d8a94
New namespace parsing
9 years ago
a4b116b527
Move to top-level TOC for now.
9 years ago
cc8e5d6ee5
Show local TOC
9 years ago
677df52c46
Show toc for now
9 years ago
0404c4723d
Reindent
9 years ago
d1dc81b8ba
Clean up python templates
9 years ago
aa62ad9af7
Sizable refactor of the autoapi tooling.
...
Standard template context and rendering. Also refactor YAML loading for new YAML formats.
9 years ago
f178316671
Add real docs
9 years ago
d21b62937b
Clean up the python code more.
9 years ago
adf2f0c38c
Skip toc’s explicitly
9 years ago
09097cf364
Fix Python support
9 years ago
56ceab81e5
Make namespaces sort by type
9 years ago
6a6c77d6ec
Add toc to detail pages
9 years ago
927179d1af
Fix unicode and data errors.
9 years ago
0a457d1016
Move find_files to the base class, and recurse.
9 years ago
21fbea84dc
Simple fix for duplicate children
9 years ago
aa59338a51
Add Max Depth
9 years ago
15f1ebfa8a
Clean up namespace listing
9 years ago
d2e85cd8bb
return -> return type
9 years ago
89bdf1c0e2
Add return type in parameter list
9 years ago
80b101dc5e
Add basic inheritance, only supports class instances so far
9 years ago
d2e41f99e0
Drop unused sort method
9 years ago
655aff0245
Cleaning up detail page formatting and order
9 years ago
6aa8ced49f
Add dl based listing of namespace objects with truncated names
...
This replaces a table that was constraining text area
9 years ago
e7be3b1804
Sorting on list and detail pages, plus type and ref type fixes to classes
9 years ago
5a5ae1cf15
Move names to properties in code and templates, add tests
9 years ago
c4c16d6bf4
Push template type call to class variable
9 years ago
4b13bebc8e
Large refactor. Cleans up, adds tests, intermediate namespaces
...
Indexes are still broken due to past changes, but intermediate namespaces are
now linkable.
9 years ago
6eae5e4eab
Indexing isn't working, temporary fix
9 years ago
3f454b3d66
Make context output behavior overridable
9 years ago
11cc2b29b9
Add param list output
9 years ago
8010a6463f
Have nicer URL's
9 years ago
a4a1a8604f
Add virtual namespaces and abstract templates into extended bases
9 years ago
15f82b4eaf
Clean up rendering and complete types and refs
9 years ago
84cce0ee59
Render namespaces as a table
9 years ago
1cdc6c004c
Fill out full type information for dotnet
9 years ago
0d88911a53
Use proper namespace fanciness
9 years ago
9aebd2500c
Refactor autoapi bits
9 years ago
a357a2ce13
Update templates
9 years ago
8b177e5a9e
Updates for python stuff
9 years ago
c7bef8e11b
Initial commit
9 years ago
Ashley Whetter
Ashley Whetter
Ashley Whetter
fredbi
Sam Lai
Sam Lai
Anthony
Eric Holscher
Daniel Roth
Christopher Swenson