Commit Graph

56 Commits

Author SHA1 Message Date
Ashley Whetter
86a9ffdd60 Fixed lint errors 2017-11-08 16:04:25 -08:00
Eric Holscher
5e18b65a6c Lots of updates to handle file pathing more sanely. 2016-08-25 16:25:38 -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 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
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
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
4de4b376ca Rename autoapi_dir to autoapi_dirs to support multiple 2015-09-23 16:00:43 -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
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
0c1583ac40 Add proper exceptions 2015-08-03 13:55:33 -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
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
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
2abc73ce30 Use proper passed in patterns 2015-07-08 15:14:59 -07:00