Anthony Johnson
2603729925
Fix some more parsing issues
8 years ago
Anthony Johnson
0faeb500ee
More fixes
8 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
8 years ago
Eric Holscher
426d677324
Fix review feedback
8 years ago
Eric Holscher
d7e8e13613
Don't use string
8 years ago
Eric Holscher
6024223d9e
Add fix to version checking on <1.5
8 years ago
Ashley Whetter
a9521553d9
Fix for Sphinx 1.5
8 years ago
Eric Holscher
d34af13767
Fix pathing
8 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
aa06999300
Nest the wrapper
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
c557182525
Fix review feedback
8 years ago
Eric Holscher
73324fab7e
Remove unneeded index entry
8 years ago
Eric Holscher
c3db6e5bc8
Python 3 fixes
8 years ago
Eric Holscher
66fd939395
Add a bit more error handling.
8 years ago
Eric Holscher
624eeff030
Break out toctree into separate file.
...
Also add lots of docstrings,
so hopefully someone can understand this some day.
8 years ago
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
9 years ago
Eric Holscher
92ef8f60db
Merge pull request #71 from rtfd/list-remove-namespace
...
Use short name for reference link name
9 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
9 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.
9 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.
9 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
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
460aea6a8b
Stub out XML parsing
9 years ago
Eric Holscher
f8e1d7435c
Kill redefined ref_name
9 years ago
Eric Holscher
ee6a2ada3c
Use ref_name instead of hacking specific name
9 years ago
Eric Holscher
c14ae7e8f1
Fix linting
9 years ago
Eric Holscher
05d891915f
Kill wrong bash prefix
9 years ago
Anthony
d4dd35a0e2
Merge pull request #20 from rtfd/appveyor
...
Add Windows builds
9 years ago
Eric Holscher
d1fdfa1526
Fix call to join
9 years ago
Eric Holscher
b66a83b550
Fix shell=True
9 years ago
Eric Holscher
dfbae94963
Handle empty objects list
9 years ago
Eric Holscher
243549f2fe
Add shell=True to the docfx call
9 years ago
Eric Holscher
3c89158662
Explicitly call bash for docfx
9 years ago
Eric Holscher
d7945ac5ba
Explicitly call bash for docfx
9 years ago
Eric Holscher
999a031108
Only open files for writing
9 years ago
Eric Holscher
220599c22f
Attempt to fix path names on Windows.
9 years ago
Eric Holscher
a21f88c806
Add comment
9 years ago
Eric Holscher
b4fdac80d3
Raise exception properly on Python 3
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
f9d4d8c18d
Clean up tox file
9 years ago
Eric Holscher
0c1583ac40
Add proper exceptions
9 years ago
Eric Holscher
6a67c16642
Fix the last of the linting errors
9 years ago
Eric Holscher
e397229177
Be more defensive in deletes
9 years ago
Eric Holscher
e00fc127cc
Clean up errors caught by linting
9 years ago
Eric Holscher
d1d452a0a4
Add ability for per-mapper cleanup tasks.
9 years ago
Eric Holscher
118fa50e11
Fix circular import
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
1df370b682
Don’t assume we have defaults for all types.
9 years ago
Eric Holscher
c81ab2873d
Add default ignore patterns.
9 years ago
Eric Holscher
82945f6068
Fix syntax parsing
9 years ago
Anthony Johnson
0dd05ba0aa
Fix environment call for failing tests
9 years ago
Anthony Johnson
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
Eric Holscher
481bf32b15
Match ignore patterns again full filename
9 years ago
Eric Holscher
2abc73ce30
Use proper passed in patterns
9 years ago
Eric Holscher
c20783558e
Add vbproj to dotnet default mapping
9 years ago
Eric Holscher
cb28412dfd
Fix test mocks
9 years ago
Eric Holscher
6f6e09b1f6
Properly handle multiple file patterns.
9 years ago
Eric Holscher
dac1ee0f2e
Properly look for substring
9 years ago
Eric Holscher
30e4847898
Add basic tests & small output changes for auto-adding TOCTree
9 years ago
Eric Holscher
ba1a09a8d1
Add ability to auto-inject AutoAPI into TocTree
9 years ago
Eric Holscher
1eb7f4c6fa
Merge branch 'master' of github.com:rtfd/sphinx-autoapi
9 years ago
Eric Holscher
9163a0088a
Catch TypeError in JS mapper.
9 years ago
Eric Holscher
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
Eric Holscher
63a7c499fc
Resort imports
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
463816673d
Small dotnet updates
9 years ago
Eric Holscher
8770a04bf8
Update dotnet codebase for new tooling
9 years ago
Eric Holscher
5d861d13d8
Clean up handling of python args/params.
9 years ago
Eric Holscher
685665535f
Rename files
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
732942828f
Use ordered dicts for mapping.
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
4f6474440d
Add some docstrings
9 years ago
Eric Holscher
057100b1ee
Rename base objects to be more descriptive.
9 years ago
Eric Holscher
59add63ae4
Refactor DotNet Domain, and clean up tests.
9 years ago
Eric Holscher
0c1bcece23
Small domain cleanup
9 years ago
Eric Holscher
d0cb6ae6e0
Clean up AutoAPI output and naming
9 years ago
Eric Holscher
d424993e8c
Safer file writing
9 years ago
Eric Holscher
6c204dc570
Update go Domain and add basic Go test
9 years ago
Eric Holscher
a94e3d8c60
Clean up warnings and move jinja_env onto base
9 years ago
Eric Holscher
c02cd9d32e
Add testing for template overrides.
9 years ago
Eric Holscher
5ca2ee76a5
Refactor into nicer top-level interface to the Domains.
...
Languages refactored:
* Python
* JS
9 years ago
Eric Holscher
1d3bd2012e
Refactor some settings and jinja env.
9 years ago
Eric Holscher
9bc6072283
Add initial javascript support with jsdoc 3.
9 years ago
Eric Holscher
df6e952a51
Fix python calls to create_class
9 years ago
Eric Holscher
c3239118b0
Move base into domains directory.
9 years ago
Eric Holscher
426c3db619
Kill unused utils file.
9 years ago
Anthony Johnson
3e5eaf2180
Merge branch 'go-support'
9 years ago
Anthony Johnson
966cce1051
Default autoapi to python instead of dotnet
9 years ago
Anthony Johnson
481bd777cb
Fix spacing on parameter output and code blocks
9 years ago
Eric Holscher
b56f2dc1d8
Merge remote-tracking branch 'origin/go-parsed-example'
9 years ago
Anthony Johnson
c2fd90fd21
Fix handling of create_class as a generator
9 years ago
Anthony Johnson
ff8292af6f
Clean up print statement
9 years ago
Anthony Johnson
c270b9de14
Move parameter name list up to signature
9 years ago
Anthony Johnson
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
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