Archives/sphinx-autoapi
2
0
Fork 0
mirror of https://github.com/readthedocs/sphinx-autoapi synced 2024-11-16 00:12:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
329 Commits 14 Branches 43 Tags 5 MiB
18ed62b0b2
Commit Graph

329 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
Anthony Johnson
18ed62b0b2 Stop using requirements.txt 
sphinx-autoapi is redistributable, we should be using setup.py for all of our
dependency management, not continuing to split off things into requirements. 
Included a shortcut in the requirements for installing tox (the only dev requirement)
and the package in develop.
 2016-10-25 16:28:12 -07:00
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.
 2016-10-25 16:27:05 -07:00
Anthony Johnson
a5a34df7f4 Basic cleanup on docstrings, import order 2016-10-25 16:26:30 -07:00
Eric Holscher
8e97201423 A few more PYthon upgrades 2016-10-20 14:57:07 -07:00
Eric Holscher
5e18b65a6c Lots of updates to handle file pathing more sanely. 2016-08-25 16:25:38 -07:00
Eric Holscher
3aa1747795 Template updates. 2016-08-25 16:23:48 -07:00
Eric Holscher
6025db45a7 Clean up how we handle file suffix. 2016-08-25 10:58:06 -07:00
Eric Holscher
b24293e545 Start using pydocstyle for Python doc generation 2016-06-09 15:44:30 -07:00
Eric Holscher
7f50c62e35 Release 0.3 with autoapi_dirs setting 2016-06-09 15:44:30 -07:00
Eric Holscher
423a4aafa7 Merge pull request #77 from rtfd/py3-fixes 
Revert basestring -> str in check for autoapi_dirs
 2016-06-08 16:46:49 -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
bc62802dd9 Merge pull request #73 from rtfd/docfx-fixes 
Make docfx great again!
 2016-06-03 12:52:16 -07:00
Anthony Johnson
216d0e824b Doc updates 2016-06-02 18:03:54 -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
Anthony
dcb88b119c Merge pull request #76 from danroth27/patch-2 
Fix indentation of code examples for properties.
 2016-06-02 17:11:36 -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
Eric Holscher
92ef8f60db Merge pull request #71 from rtfd/list-remove-namespace 
Use short name for reference link name
 2016-05-01 20:37:51 -07:00
Eric Holscher
06245790dc Merge pull request #70 from rtfd/fix-apidir 
Handle string input for api dir
 2016-05-01 20:37:06 -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
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
20a1852907 Fix outdated fixture data 2016-03-25 18:17:05 -07:00
Anthony Johnson
04726106d2 Fix indentation on code block in .NET template 2016-03-25 17:39:00 -07:00
Eric Holscher
eed0038efb Merge pull request #66 from rtfd/spec-identifier-lookup 
Add resolution to spec identifiers using docfx references
 2016-03-10 09:45:36 -08: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
Eric Holscher
3a73a2c9c4 Merge pull request #64 from rtfd/comment-parsing-fixes 
Fix parsing issues with code comment XML
 2016-02-26 11:24:43 -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
Anthony Johnson
498a0c31de Merge branch 'appveyor-config' 2016-02-25 11:46:16 -08:00
Anthony Johnson
12e85828f0 Clone test repo before testing 2016-02-25 11:43:44 -08:00
Anthony Johnson
bfccdf49aa Try again to fix appveyor certificates 2016-02-24 10:16:31 -08:00
Anthony Johnson
53357dd5df Another fix to appveyor 2016-02-24 10:01:47 -08:00
Anthony Johnson
5bf691e0ef Fix appveyor config for pip 2016-02-23 17:00:14 -08:00
Daniel Roth
ca3a002aa6 Update extension.py to handle absolute paths 2016-02-02 21:14:28 -08:00
Eric Holscher
264cfcbf45 Merge pull request #51 from rtfd/fix-list-styling 
.NET template output breaks definition lists on listing pages
 2016-01-15 10:31:20 -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
Eric Holscher
52f3558953 Merge pull request #40 from rtfd/template-path 
Fix template path issues on windows
 2015-10-30 19:33:53 -07: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
Eric Holscher
0cfa8bbcbb Merge pull request #39 from rtfd/ref-escaping 
References and escaping issues with transformed XML content
 2015-10-27 09:19:02 -07:00