Commit Graph

399 Commits

Author SHA1 Message Date
Eric Holscher
aa06999300 Nest the wrapper 2016-11-04 15:19:56 -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
5b69857df0 Merge pull request #87 from rtfd/toc-addition-extension
Build initial toctree insertion implementation
2016-11-04 13:43:59 -07:00
Eric Holscher
c557182525 Fix review feedback 2016-11-04 13:42:15 -07:00
Eric Holscher
215dd06e0a Add basic test for TOC Tree insertion 2016-11-03 19:52:54 -07:00
Eric Holscher
73324fab7e Remove unneeded index entry 2016-11-03 13:24:22 -07:00
Eric Holscher
c3db6e5bc8 Python 3 fixes 2016-11-03 13:13:36 -07:00
Eric Holscher
66fd939395 Add a bit more error handling. 2016-11-03 13:13:36 -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
Eric Holscher
6ff30f7d14 Merge pull request #88 from rtfd/fix-nested-directive
Revert attempt at making a hidden title
2016-11-03 13:12:59 -07:00
Anthony Johnson
2bff9e45b7 Revert attempt at making a hidden title
This directive was to remove the initial title from the nest block
2016-11-02 20:01:21 -07:00
Anthony
76c458f85f Merge pull request #78 from rtfd/python-upgrades
Start using pydocstyle for Python doc generation
2016-11-02 20:00:09 -07:00
Eric Holscher
97e84f2e40 Merge pull request #86 from rtfd/pydocstyle-improvements
Improvements to pydocstyle Python parsing
2016-11-02 18:46:17 -07:00
Anthony Johnson
809c27ac6d Lint fixes 2016-11-02 16:45:41 -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
Anthony Johnson
04805b5044 Fix version number
The module is actually 0.4 release currently. This is not a new release however,
so updated to match 0.4, no additional increment necessary yet.
2016-10-25 16:30:59 -07:00
Anthony Johnson
de56f25fe5 Add ignore for rope 2016-10-25 16:28:36 -07:00
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