Commit Graph

175 Commits (6025db45a779ddc1dd2ac9559fa50f28cadbb193)

Author SHA1 Message Date
Eric Holscher 6025db45a7 Clean up how we handle file suffix. 8 years ago
Eric Holscher b24293e545 Start using pydocstyle for Python doc generation 8 years ago
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
8 years ago
Anthony Johnson 216d0e824b Doc updates 8 years ago
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
8 years ago
Daniel Roth e51480d747 Fix indentation of code examples for properties. 8 years ago
Eric Holscher 58cb1ee64d Merge pull request #72 from rtfd/net-detail-cleanup
Clean up .NET detail page, add assemblies list
8 years ago
Eric Holscher 92ef8f60db Merge pull request #71 from rtfd/list-remove-namespace
Use short name for reference link name
8 years ago
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
8 years ago
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.
8 years ago
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.
8 years ago
Anthony 26924f93e3 Merge pull request #54 from danroth27/patch-1
Update extension.py to handle absolute paths
9 years ago
Eric Holscher 72a888edde Merge pull request #67 from rtfd/dotnet-code-example-indent
Fix indentation on code block in .NET template
9 years ago
Anthony Johnson 04726106d2 Fix indentation on code block in .NET template 9 years ago
Anthony Johnson 4fef4ab2c1 Complete statement 9 years ago
Anthony Johnson 49af2b252a Update reference resolver for nested resolution 9 years ago
Anthony Johnson b6b1bb0f8b Fix missing key issue 9 years ago
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
9 years ago
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
9 years ago
Daniel Roth ca3a002aa6 Update extension.py to handle absolute paths 9 years ago
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.
9 years ago
Anthony Johnson a672d55187 Lint fix 9 years ago
Anthony Johnson bcee7eb22a Use autoapi_root for url root configuration 9 years ago
Anthony Johnson 61db34a4d6 Move include path to base object 9 years ago
Anthony Johnson d30fa32762 Add configurable url prefix 9 years ago
Anthony Johnson 93869e4ad6 Deconstruct pathname on object 9 years ago
Anthony Johnson 3fd930f4fb Try it again 9 years ago
Anthony Johnson 5fa272ca4b Fix template path issue on windows, fixes #37 9 years ago
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.
9 years ago
Anthony Johnson af5bb7daeb Fix some escaping issues with transformed XML content
Fixes #38
9 years ago
Eric Holscher 3dfd9ac47f Fix error 9 years ago
Eric Holscher 81d4568713 Merge pull request #35 from rtfd/support-multiple-source-dirs
Rename `autoapi_dir` to `autoapi_dirs` to support multiple source dirs
9 years ago
Eric Holscher 2958bc34fb Fix linting errors 9 years ago
Eric Holscher 4de4b376ca Rename `autoapi_dir` to `autoapi_dirs` to support multiple 9 years ago
Daniel Roth 180c1bb36b Update extension.py
Missing an 's'
9 years ago
Anthony Johnson c645cc18c0 Fix env passed to command, drop docfx.cmd detection 9 years ago
Anthony Johnson 47fbd54623 Drop shell subprocess execution 9 years ago
Anthony Johnson 9b75431e6e Configure docfx command by system 9 years ago
Eric Holscher 3a22ae63e0 Merge pull request #23 from rtfd/doc-name-slugging
Use more proper slugging on filenames for object
9 years ago
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.
9 years ago
Anthony Johnson 436eb28d9f Parse out doc id prefixes and add reference types 9 years ago
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
9 years ago
Eric Holscher 460aea6a8b Stub out XML parsing 9 years ago
Eric Holscher f8e1d7435c Kill redefined ref_name 9 years ago
Eric Holscher ee6a2ada3c Use ref_name instead of hacking specific name 9 years ago
Eric Holscher c14ae7e8f1 Fix linting 9 years ago
Eric Holscher 05d891915f Kill wrong bash prefix 9 years ago
Anthony d4dd35a0e2 Merge pull request #20 from rtfd/appveyor
Add Windows builds
9 years ago
Eric Holscher d1fdfa1526 Fix call to join 9 years ago
Eric Holscher b66a83b550 Fix shell=True 9 years ago