Commit Graph

180 Commits

Author SHA1 Message Date
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
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
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
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
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