Commit Graph

58 Commits

Author SHA1 Message Date
Eric Holscher
3531f5560a Merge remote-tracking branch 'origin/master' into cleanup-june 2017-11-09 10:51:24 -07:00
Ashley Whetter
a1a3f05202 Fix for Sphinx 1.6 2017-11-05 14:18:43 -08:00
Eric Holscher
3875cf495d Fix noting the toctree 2017-06-29 15:10:06 -07:00
Eric Holscher
efb541f78a Add ability to add API to top-level TOC. 2017-06-27 17:12:47 -07:00
Eric Holscher
426d677324 Fix review feedback 2017-03-02 14:18:39 -08:00
Eric Holscher
d7e8e13613 Don't use string 2017-02-08 10:12:52 -05:00
Eric Holscher
6024223d9e Add fix to version checking on <1.5 2017-02-08 09:53:19 -05:00
Ashley Whetter
a9521553d9 Fix for Sphinx 1.5 2017-02-01 17:14:32 -08:00
Eric Holscher
c557182525 Fix review feedback 2016-11-04 13:42:15 -07:00
Eric Holscher
73324fab7e Remove unneeded index entry 2016-11-03 13:24:22 -07:00
Eric Holscher
624eeff030 Break out toctree into separate file.
Also add lots of docstrings,
so hopefully someone can understand this some day.
2016-11-03 13:13:36 -07:00
Eric Holscher
cc41787b58 Write up a more descriptive docstring 2016-11-03 13:13:36 -07:00
Eric Holscher
b6dc3d23d8 Clean up auto-tocing 2016-11-03 13:13:36 -07:00
Eric Holscher
4eefb01759 Build initial toctree implementation 2016-11-03 13:13:36 -07:00
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
2016-11-02 16:29:28 -07:00
Eric Holscher
6025db45a7 Clean up how we handle file suffix. 2016-08-25 10:58:06 -07:00
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
2016-06-08 16:36:11 -07:00
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.
2016-05-01 19:23:05 -07:00
Daniel Roth
ca3a002aa6 Update extension.py to handle absolute paths 2016-02-02 21:14:28 -08:00
Anthony Johnson
bcee7eb22a Use autoapi_root for url root configuration 2015-10-28 11:04:23 -07:00
Anthony Johnson
d30fa32762 Add configurable url prefix 2015-10-27 11:35:44 -07:00
Eric Holscher
3dfd9ac47f Fix error 2015-10-12 10:50:46 -07:00
Eric Holscher
81d4568713 Merge pull request #35 from rtfd/support-multiple-source-dirs
Rename `autoapi_dir` to `autoapi_dirs` to support multiple source dirs
2015-10-09 17:10:26 -07:00
Eric Holscher
2958bc34fb Fix linting errors 2015-09-23 16:04:45 -07:00
Eric Holscher
4de4b376ca Rename autoapi_dir to autoapi_dirs to support multiple 2015-09-23 16:00:43 -07:00
Daniel Roth
180c1bb36b Update extension.py
Missing an 's'
2015-09-22 08:02:34 -07:00
Eric Holscher
f9d4d8c18d Clean up tox file 2015-08-03 14:01:54 -07:00
Eric Holscher
0c1583ac40 Add proper exceptions 2015-08-03 13:55:33 -07:00
Eric Holscher
6a67c16642 Fix the last of the linting errors 2015-08-03 13:12:34 -07:00
Eric Holscher
d1d452a0a4 Add ability for per-mapper cleanup tasks. 2015-08-03 10:36:10 -07:00
Eric Holscher
1df370b682 Don’t assume we have defaults for all types. 2015-07-20 11:51:41 -07:00
Eric Holscher
c81ab2873d Add default ignore patterns. 2015-07-20 11:51:41 -07:00
Eric Holscher
c20783558e Add vbproj to dotnet default mapping 2015-07-08 15:13:24 -07:00
Eric Holscher
cb28412dfd Fix test mocks 2015-07-07 16:32:38 -07:00
Eric Holscher
6f6e09b1f6 Properly handle multiple file patterns. 2015-07-07 16:19:25 -07:00
Eric Holscher
dac1ee0f2e Properly look for substring 2015-07-07 15:48:00 -07:00
Eric Holscher
30e4847898 Add basic tests & small output changes for auto-adding TOCTree 2015-07-07 15:43:12 -07:00
Eric Holscher
ba1a09a8d1 Add ability to auto-inject AutoAPI into TocTree 2015-07-07 15:30:16 -07:00
Eric Holscher
685665535f Rename files 2015-06-10 14:23:58 -07:00
Eric Holscher
f60b7d8880 Add ability to configure options of display of objects. 2015-06-10 13:58:52 -07:00
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
2015-06-10 13:13:34 -07:00
Eric Holscher
d0cb6ae6e0 Clean up AutoAPI output and naming 2015-06-10 11:35:54 -07:00
Eric Holscher
c02cd9d32e Add testing for template overrides. 2015-06-10 10:33:18 -07:00
Eric Holscher
5ca2ee76a5 Refactor into nicer top-level interface to the Domains.
Languages refactored:

* Python
* JS
2015-06-06 16:11:49 -07:00
Eric Holscher
9bc6072283 Add initial javascript support with jsdoc 3. 2015-06-06 13:08:44 -07:00
Anthony Johnson
966cce1051 Default autoapi to python instead of dotnet 2015-06-01 11:29:19 -07:00
Eric Holscher
9bdd44d8cd Add a basic go domain. 2015-05-29 15:22:06 -07:00
Eric Holscher
aa62ad9af7 Sizable refactor of the autoapi tooling.
Standard template context and rendering. Also refactor YAML loading for new YAML formats.
2015-04-23 13:31:03 -07:00
Eric Holscher
09097cf364 Fix Python support 2015-04-20 22:54:32 -07:00
Eric Holscher
15f1ebfa8a Clean up namespace listing 2015-04-16 11:39:32 -07:00