Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-11 19:10:58 +00:00
Code Issues Packages Projects Releases Wiki Activity
744 Commits 14 Branches 43 Tags 5 MiB
6317148f0d
Commit Graph

125 Commits

Author SHA1 Message Date
Eric Holscher
491f8c9065 Keep nested-parse 2016-11-04 15:34:48 -07:00
Eric Holscher
ffb2130b55 Implement prepare_docstring filter that wraps Sphinx's 
This allows us to output docstrings in a reasonable fashion.
 2016-11-04 15:17:50 -07:00
Eric Holscher
b6dc3d23d8 Clean up auto-tocing 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
3aa1747795 Template updates. 2016-08-25 16:23:48 -07:00
Eric Holscher
b24293e545 Start using pydocstyle for Python doc generation 2016-06-09 15:44:30 -07:00
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
 2016-06-02 17:24:31 -07:00
Daniel Roth
e51480d747 Fix indentation of code examples for properties. 2016-06-02 13:58:26 -07:00
Eric Holscher
58cb1ee64d Merge pull request #72 from rtfd/net-detail-cleanup 
Clean up .NET detail page, add assemblies list
 2016-05-02 07:36:48 -07:00
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
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
49af2b252a Update reference resolver for nested resolution 2016-03-04 10:05:21 -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
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
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
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
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
5d861d13d8 Clean up handling of python args/params. 2015-06-10 14:37:17 -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
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
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
481bd777cb Fix spacing on parameter output and code blocks 2015-06-01 11:26:19 -07:00
Anthony Johnson
c270b9de14 Move parameter name list up to signature 2015-05-31 14:38:17 -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
Anthony Johnson
af539d8868 Untested first pass of templates 2015-05-29 15:02:27 -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
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
d21b62937b Clean up the python code more. 2015-04-22 10:12:05 -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
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
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
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