Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-10 01:10:27 +00:00
Code Issues Packages Projects Releases Wiki Activity
643 Commits 14 Branches 43 Tags 5 MiB
7541f922ae
Commit Graph

367 Commits

Author SHA1 Message Date
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
 2016-05-01 19:57:58 -07:00
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.
 2016-05-01 19:27:20 -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
Anthony
26924f93e3 Merge pull request #54 from danroth27/patch-1 
Update extension.py to handle absolute paths
 2016-04-21 13:36:58 -07:00
Eric Holscher
72a888edde Merge pull request #67 from rtfd/dotnet-code-example-indent 
Fix indentation on code block in .NET template
 2016-03-30 23:28:39 -07:00
Anthony Johnson
04726106d2 Fix indentation on code block in .NET template 2016-03-25 17:39:00 -07:00
Anthony Johnson
4fef4ab2c1 Complete statement 2016-03-04 10:49:01 -08:00
Anthony Johnson
49af2b252a Update reference resolver for nested resolution 2016-03-04 10:05:21 -08:00
Anthony Johnson
b6b1bb0f8b Fix missing key issue 2016-02-26 15:13:05 -08:00
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
 2016-02-25 14:35:09 -08:00
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
 2016-02-25 11:46:56 -08:00
Daniel Roth
ca3a002aa6 Update extension.py to handle absolute paths 2016-02-02 21:14:28 -08:00
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.
 2016-01-12 16:33:34 -08:00
Anthony Johnson
a672d55187 Lint fix 2016-01-12 16:33:10 -08:00
Anthony Johnson
bcee7eb22a Use autoapi_root for url root configuration 2015-10-28 11:04:23 -07:00
Anthony Johnson
61db34a4d6 Move include path to base object 2015-10-27 11:35:44 -07:00
Anthony Johnson
d30fa32762 Add configurable url prefix 2015-10-27 11:35:44 -07:00
Anthony Johnson
93869e4ad6 Deconstruct pathname on object 2015-10-27 11:34:54 -07:00
Anthony Johnson
3fd930f4fb Try it again 2015-10-27 11:34:54 -07:00
Anthony Johnson
5fa272ca4b Fix template path issue on windows, fixes #37 2015-10-27 11:34:54 -07:00
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.
 2015-10-27 01:12:25 -07:00
Anthony Johnson
af5bb7daeb Fix some escaping issues with transformed XML content 
Fixes #38
 2015-10-27 00:46:59 -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
Anthony Johnson
c645cc18c0 Fix env passed to command, drop docfx.cmd detection 2015-08-21 01:13:08 -07:00
Anthony Johnson
47fbd54623 Drop shell subprocess execution 2015-08-20 22:11:16 -07:00
Anthony Johnson
9b75431e6e Configure docfx command by system 2015-08-20 22:01:25 -07:00
Eric Holscher
3a22ae63e0 Merge pull request #23 from rtfd/doc-name-slugging 
Use more proper slugging on filenames for object
 2015-08-19 10:48:10 -07:00
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.
 2015-08-18 18:10:25 -07:00
Anthony Johnson
436eb28d9f Parse out doc id prefixes and add reference types 2015-08-18 14:30:08 -07:00
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
 2015-08-18 12:22:46 -07:00
Eric Holscher
460aea6a8b Stub out XML parsing 2015-08-18 12:22:46 -07:00
Eric Holscher
f8e1d7435c Kill redefined ref_name 2015-08-17 15:04:15 -07:00
Eric Holscher
ee6a2ada3c Use ref_name instead of hacking specific name 2015-08-17 15:02:06 -07:00
Eric Holscher
c14ae7e8f1 Fix linting 2015-08-17 13:03:21 -07:00
Eric Holscher
05d891915f Kill wrong bash prefix 2015-08-17 12:54:10 -07:00
Anthony
d4dd35a0e2 Merge pull request #20 from rtfd/appveyor 
Add Windows builds
 2015-08-17 11:01:31 -07:00
Eric Holscher
d1fdfa1526 Fix call to join 2015-08-14 14:58:13 -07:00
Eric Holscher
b66a83b550 Fix shell=True 2015-08-14 14:57:15 -07:00
Eric Holscher
dfbae94963 Handle empty objects list 2015-08-14 14:54:28 -07:00
Eric Holscher
243549f2fe Add shell=True to the docfx call 2015-08-14 14:45:49 -07:00
Eric Holscher
3c89158662 Explicitly call bash for docfx 2015-08-14 14:34:58 -07:00
Eric Holscher
d7945ac5ba Explicitly call bash for docfx 2015-08-14 14:34:46 -07:00
Eric Holscher
999a031108 Only open files for writing 2015-08-10 20:16:40 -07:00
Eric Holscher
220599c22f Attempt to fix path names on Windows. 2015-08-10 20:03:46 -07:00
Eric Holscher
a21f88c806 Add comment 2015-08-05 10:10:32 -07:00
Eric Holscher
b4fdac80d3 Raise exception properly on Python 3 2015-08-05 10:09:07 -07:00
Eric Holscher
acef865e6f Fix up python 3 support. 
This works for everything except epyparse currently.
 2015-08-04 10:19:17 -07:00
Eric Holscher
2152ae373b Add support for optionally raising error. 2015-08-03 14:13:08 -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
e397229177 Be more defensive in deletes 2015-08-03 12:11:47 -07:00
Eric Holscher
e00fc127cc Clean up errors caught by linting 2015-08-03 11:59:02 -07:00
Eric Holscher
d1d452a0a4 Add ability for per-mapper cleanup tasks. 2015-08-03 10:36:10 -07:00
Eric Holscher
118fa50e11 Fix circular import 2015-08-03 10:35:26 -07:00
Eric Holscher
095b1e5b29 Add Indentity as the default dotnet testing project. 
Also lots of little cleanup to remove errors on those builds.
 2015-07-20 14:48:25 -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
82945f6068 Fix syntax parsing 2015-07-20 11:51:41 -07:00
Anthony Johnson
0dd05ba0aa Fix environment call for failing tests 2015-07-20 11:51:41 -07:00
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.
 2015-07-20 11:51:41 -07:00
Eric Holscher
481bf32b15 Match ignore patterns again full filename 2015-07-20 10:50:35 -07:00
Eric Holscher
2abc73ce30 Use proper passed in patterns 2015-07-08 15:14:59 -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
1eb7f4c6fa Merge branch 'master' of github.com:rtfd/sphinx-autoapi 2015-07-06 16:17:29 -07:00
Eric Holscher
9163a0088a Catch TypeError in JS mapper. 2015-06-22 23:25:25 -04:00
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.
 2015-06-22 23:24:59 -04:00
Eric Holscher
63a7c499fc Resort imports 2015-06-21 23:05:03 -04:00
Eric Holscher
51fe162fb0 Cleanup to address review 2015-06-21 23:03:45 -04:00
Eric Holscher
4e9f1c02ea More small dotnet cleanup 2015-06-21 22:58:29 -04:00
Eric Holscher
463816673d Small dotnet updates 2015-06-21 22:03:14 -04:00
Eric Holscher
8770a04bf8 Update dotnet codebase for new tooling 2015-06-14 16:14:16 -04:00
Eric Holscher
5d861d13d8 Clean up handling of python args/params. 2015-06-10 14:37:17 -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
bdae9f083c Add ability to hide undocumented methods, etc. 2015-06-10 13:33:42 -07:00
Eric Holscher
732942828f Use ordered dicts for mapping. 2015-06-10 13:33:28 -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
4f6474440d Add some docstrings 2015-06-10 13:12:18 -07:00
Eric Holscher
057100b1ee Rename base objects to be more descriptive. 2015-06-10 11:53:09 -07:00
Eric Holscher
59add63ae4 Refactor DotNet Domain, and clean up tests. 2015-06-10 11:48:15 -07:00
Eric Holscher
0c1bcece23 Small domain cleanup 2015-06-10 11:47:50 -07:00
Eric Holscher
d0cb6ae6e0 Clean up AutoAPI output and naming 2015-06-10 11:35:54 -07:00
Eric Holscher
d424993e8c Safer file writing 2015-06-10 11:35:30 -07:00
Eric Holscher
6c204dc570 Update go Domain and add basic Go test 2015-06-10 11:04:19 -07:00
Eric Holscher
a94e3d8c60 Clean up warnings and move jinja_env onto base 2015-06-10 11:01:06 -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
1d3bd2012e Refactor some settings and jinja env. 2015-06-06 13:44:01 -07:00
Eric Holscher
9bc6072283 Add initial javascript support with jsdoc 3. 2015-06-06 13:08:44 -07:00
Eric Holscher
df6e952a51 Fix python calls to create_class 2015-06-01 14:14:21 -07:00
Eric Holscher
c3239118b0 Move base into domains directory. 2015-06-01 14:14:15 -07:00
Eric Holscher
426c3db619 Kill unused utils file. 2015-06-01 14:13:54 -07:00
Anthony Johnson
3e5eaf2180 Merge branch 'go-support' 2015-06-01 11:38:02 -07:00
Anthony Johnson
966cce1051 Default autoapi to python instead of dotnet 2015-06-01 11:29:19 -07:00
Anthony Johnson
481bd777cb Fix spacing on parameter output and code blocks 2015-06-01 11:26:19 -07:00
Eric Holscher
b56f2dc1d8 Merge remote-tracking branch 'origin/go-parsed-example' 2015-06-01 11:24:03 -07:00
Anthony Johnson
c2fd90fd21 Fix handling of create_class as a generator 2015-06-01 11:20:54 -07:00
Anthony Johnson
ff8292af6f Clean up print statement 2015-05-31 14:41:16 -07:00
Anthony Johnson
c270b9de14 Move parameter name list up to signature 2015-05-31 14:38:17 -07:00
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.
 2015-05-30 22:03:19 -07:00
Anthony Johnson
181c7ea2a4 Add child display 2015-05-30 18:42:06 -07:00
Anthony Johnson
808c1a090f Add parameters to output 2015-05-30 18:32:43 -07:00
Anthony Johnson
8819b46a2f Clean up cruft and handle a few failures better 2015-05-30 16:28:59 -07:00
Anthony Johnson
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.
 2015-05-29 20:09:36 -07:00
Eric Holscher
f133c7d603 Fix package output for now. 2015-05-29 16:02:56 -07:00
Eric Holscher
18533426c3 Add title to package 2015-05-29 15:54:50 -07:00
Eric Holscher
cdd8d244de Fix up templates 2015-05-29 15:48:58 -07:00
Eric Holscher
a4a68d9213 Fix up go stuff 2015-05-29 15:34:51 -07:00
Eric Holscher
9bdd44d8cd Add a basic go domain. 2015-05-29 15:22:06 -07:00
Anthony Johnson
af539d8868 Untested first pass of templates 2015-05-29 15:02:27 -07:00
Christopher Swenson
0ccde8454a Fix double autoapi_dir prepended to find_files 2015-05-29 14:34:05 -07:00
Anthony Johnson
9612dae694 Add better reference and obj id handling for generics 2015-04-24 18:32:16 -07:00
Anthony Johnson
a3cea299dc Adding indentation on .net detail template, hidden types 2015-04-24 15:04:10 -07:00
Eric Holscher
a05a85507a Add GitHub section 2015-04-24 13:16:15 -07:00
Eric Holscher
6410bee011 Fix hierarchy, and include object itself in it. 2015-04-24 12:46:47 -07:00
Eric Holscher
c79a0f3cee Clean up namespaces and display 2015-04-24 12:37:00 -07:00
Eric Holscher
4e532d8a94 New namespace parsing 2015-04-24 10:35:05 -07:00
Eric Holscher
a4b116b527 Move to top-level TOC for now. 2015-04-24 10:10:51 -07:00
Eric Holscher
cc8e5d6ee5 Show local TOC 2015-04-24 10:10:36 -07:00
Eric Holscher
677df52c46 Show toc for now 2015-04-23 15:57:17 -07:00
Eric Holscher
0404c4723d Reindent 2015-04-23 15:52:38 -07:00
Eric Holscher
d1dc81b8ba Clean up python templates 2015-04-23 15:37:02 -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
f178316671 Add real docs 2015-04-22 15:46:40 -07:00
Eric Holscher
d21b62937b Clean up the python code more. 2015-04-22 10:12:05 -07:00
Eric Holscher
adf2f0c38c Skip toc’s explicitly 2015-04-22 10:11:56 -07:00
Eric Holscher
09097cf364 Fix Python support 2015-04-20 22:54:32 -07:00
Eric Holscher
56ceab81e5 Make namespaces sort by type 2015-04-17 14:16:59 -07:00
Eric Holscher
6a6c77d6ec Add toc to detail pages 2015-04-17 14:16:46 -07:00
Eric Holscher
927179d1af Fix unicode and data errors. 2015-04-17 14:16:24 -07:00
Eric Holscher
0a457d1016 Move find_files to the base class, and recurse. 2015-04-17 14:16:12 -07:00
Anthony Johnson
21fbea84dc Simple fix for duplicate children 2015-04-16 15:46:54 -07:00
Eric Holscher
aa59338a51 Add Max Depth 2015-04-16 14:29:38 -07:00
Eric Holscher
15f1ebfa8a Clean up namespace listing 2015-04-16 11:39:32 -07:00
Anthony Johnson
d2e85cd8bb return -> return type 2015-04-15 00:22:37 -07:00
Anthony Johnson
89bdf1c0e2 Add return type in parameter list 2015-04-15 00:10:50 -07:00
Anthony Johnson
80b101dc5e Add basic inheritance, only supports class instances so far 2015-04-14 23:35:36 -07:00
Anthony Johnson
d2e41f99e0 Drop unused sort method 2015-04-14 23:07:12 -07:00
Anthony Johnson
655aff0245 Cleaning up detail page formatting and order 2015-04-14 19:55:46 -07:00
Anthony Johnson
6aa8ced49f Add dl based listing of namespace objects with truncated names 
This replaces a table that was constraining text area
 2015-04-14 18:37:19 -07:00
Anthony Johnson
e7be3b1804 Sorting on list and detail pages, plus type and ref type fixes to classes 2015-04-14 18:05:15 -07:00
Anthony Johnson
5a5ae1cf15 Move names to properties in code and templates, add tests 2015-04-14 16:54:43 -07:00
Anthony Johnson
c4c16d6bf4 Push template type call to class variable 2015-04-14 16:24:57 -07:00
Anthony Johnson
4b13bebc8e Large refactor. Cleans up, adds tests, intermediate namespaces 
Indexes are still broken due to past changes, but intermediate namespaces are
now linkable.
 2015-04-14 15:59:09 -07:00
Anthony Johnson
6eae5e4eab Indexing isn't working, temporary fix 2015-04-13 19:11:13 -07:00
Anthony Johnson
3f454b3d66 Make context output behavior overridable 2015-04-13 19:10:33 -07:00
Anthony Johnson
11cc2b29b9 Add param list output 2015-04-13 19:10:19 -07:00
Eric Holscher
8010a6463f Have nicer URL's 2015-04-10 00:37:25 -05:00
Eric Holscher
a4a1a8604f Add virtual namespaces and abstract templates into extended bases 2015-04-10 00:37:25 -05:00
Eric Holscher
15f82b4eaf Clean up rendering and complete types and refs 2015-04-08 15:56:05 -07:00
Eric Holscher
84cce0ee59 Render namespaces as a table 2015-04-08 13:21:30 -07:00
Eric Holscher
1cdc6c004c Fill out full type information for dotnet 2015-04-07 23:42:06 -07:00
Eric Holscher
0d88911a53 Use proper namespace fanciness 2015-04-07 23:08:53 -07:00
Eric Holscher
9aebd2500c Refactor autoapi bits 2015-04-07 22:54:53 -07:00
Eric Holscher
a357a2ce13 Update templates 2015-04-07 13:35:50 -07:00
Eric Holscher
8b177e5a9e Updates for python stuff 2015-03-31 17:01:41 -07:00
Eric Holscher
c7bef8e11b Initial commit 2015-03-27 12:50:56 -07:00