Anthony Johnson
3c6e0e4015
Start altering the pydocstyle AST parser for our needs
...
This forks some of the pydocstyle AST parser into out mapper. Eventually, some
of the other operations such as parsing arguments and performing full name
lookup can be moved in as well. For now, this is not doing any extra assignment
tracking/etc, several of these operations will just throw this information out.
Refs #99
2017-04-07 11:46:57 -07:00
Eric Holscher
875d6b6ffa
Fix tests
2016-11-04 15:47:57 -07:00
Eric Holscher
215dd06e0a
Add basic test for TOC Tree insertion
2016-11-03 19:52:54 -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
Eric Holscher
b24293e545
Start using pydocstyle for Python doc generation
2016-06-09 15:44:30 -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
20a1852907
Fix outdated fixture data
2016-03-25 18:17:05 -07: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
d30fa32762
Add configurable url prefix
2015-10-27 11:35:44 -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
2fd908e2a7
Fix test
2015-10-27 00:51:26 -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
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
9dbd2f78dd
Fix os path separator
2015-08-18 18:18:54 -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
220599c22f
Attempt to fix path names on Windows.
2015-08-10 20:03:46 -07:00
Eric Holscher
a067576144
Embed functions inside test
2015-08-05 10:27:35 -07:00
Eric Holscher
8cd9ae16b3
Small readme update
2015-08-04 10:19:18 -07:00
Eric Holscher
d3b6bd305f
Skip epyparse tests on py3
2015-08-04 10:19:18 -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
26b406fbab
Don't keep files
2015-08-03 12:10:51 -07:00
Eric Holscher
2c823fd4e8
Add proper testing config
2015-08-03 11:59:15 -07:00
Eric Holscher
49897f091c
Make sure example repo exists
2015-08-03 11:55:53 -07:00
Eric Holscher
ba632296a6
Fix .NET
2015-08-03 11:49:42 -07:00
Eric Holscher
801e2e4675
Fix mock
2015-08-03 11:49:18 -07:00
Eric Holscher
afe5190bc8
Fix README to include proper command
2015-08-03 10:35:12 -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
d2e0bdb6f0
Still point at mvc
2015-07-20 11:51:41 -07:00
Eric Holscher
03eb110d1c
Remove outdated test deps from dotnet
2015-07-20 10:50:48 -07:00
Eric Holscher
cb28412dfd
Fix test mocks
2015-07-07 16:32:38 -07:00
Eric Holscher
136bb7c986
Small conf changes
2015-07-07 15:48:07 -07:00
Eric Holscher
30e4847898
Add basic tests & small output changes for auto-adding TOCTree
2015-07-07 15:43:12 -07:00
Eric Holscher
d0621199c8
Mock the subprocess call for .Net
2015-06-23 14:09:47 -07:00
Eric Holscher
19c79222a9
Refactor integration tests to use fixture data.
...
This removes dependence on real tooling.
The main downside is that it’s fragile to output changes in the tooling.
Not a lot we can do though,
other than have real integration tests, also.
2015-06-22 23:24:59 -04:00
Eric Holscher
e881072e84
Refactor integration tests
2015-06-22 22:22:27 -04:00
Eric Holscher
909abed977
Add basic README
2015-06-22 13:34:15 -04:00
Eric Holscher
fcfd6f258d
Add a basic example dir with clone script.
2015-06-21 23:00:54 -04:00
Eric Holscher
463816673d
Small dotnet updates
2015-06-21 22:03:14 -04:00
Eric Holscher
8770a04bf8
Update dotnet codebase for new tooling
2015-06-14 16:14:16 -04:00
Eric Holscher
685665535f
Rename files
2015-06-10 14:23:58 -07:00
Eric Holscher
1cde5590eb
Clean up how we render templates.
...
* Add top_level_object as global concept.
* Fix toctree generation
* Add passing of options to rendering
2015-06-10 13:13:34 -07:00
Eric Holscher
a3244a2531
Rename tests to be more descriptive
2015-06-10 11:50:14 -07:00
Eric Holscher
59add63ae4
Refactor DotNet Domain, and clean up tests.
2015-06-10 11:48:15 -07:00
Eric Holscher
a838e5333d
Default keep_files to off.
2015-06-10 11:36:07 -07:00
Eric Holscher
6c204dc570
Update go Domain and add basic Go test
2015-06-10 11:04:19 -07:00
Eric Holscher
2dcb0ca200
Add makefiles to all examples
2015-06-10 11:00:48 -07:00
Eric Holscher
c02cd9d32e
Add testing for template overrides.
2015-06-10 10:33:18 -07:00
Eric Holscher
5e0b1c6561
Remove old MS yaml file
2015-06-07 08:12:22 -07:00
Eric Holscher
5ca2ee76a5
Refactor into nicer top-level interface to the Domains.
...
Languages refactored:
* Python
* JS
2015-06-06 16:11:49 -07:00
Eric Holscher
819dfa92ca
Clean up gitignore and doctrees
2015-06-06 13:45:04 -07:00
Eric Holscher
bd92f55fc7
Install jsdoc globally
2015-06-06 13:20:11 -07:00
Eric Holscher
5468c580ce
Rename test dirs, and clarify naming
2015-06-06 13:19:08 -07:00
Eric Holscher
9bc6072283
Add initial javascript support with jsdoc 3.
2015-06-06 13:08:44 -07:00
Anthony Johnson
5d5ee6514f
Fix dotnet tests from generator return
2015-06-01 12:37:22 -07:00
Eric Holscher
b56f2dc1d8
Merge remote-tracking branch 'origin/go-parsed-example'
2015-06-01 11:24:03 -07:00
Eric Holscher
418b379a7d
Merge pull request #3 from rtfd/fix-dotnet-test
...
Update dotnet domain tests for latest data structures
2015-06-01 11:20:49 -07:00
Eric Holscher
a4a68d9213
Fix up go stuff
2015-05-29 15:34:51 -07:00
Christopher Swenson
e1b28981b7
Update dotnet domain tests for latest data structures
...
Some things had changed with how get_objects worked,
and tests needed to be updated.
2015-05-29 15:06:36 -07:00
Christopher Swenson
817b184619
Add holistic Python test that runs sphinx and EVERYTHING
2015-05-29 14:34:05 -07:00
Anthony Johnson
122810a7e1
Add explicit member types
2015-05-29 14:28:07 -07:00
Anthony Johnson
ddeba7db70
Fix notes
2015-05-29 14:25:26 -07:00
Anthony Johnson
f6f1d1dd7a
Added draft json schema fixture for parsing Go doc output
2015-05-29 14:05:03 -07:00
Anthony Johnson
e7be3b1804
Sorting on list and detail pages, plus type and ref type fixes to classes
2015-04-14 18:05:15 -07:00
Anthony Johnson
5a5ae1cf15
Move names to properties in code and templates, add tests
2015-04-14 16:54:43 -07:00
Anthony Johnson
4b13bebc8e
Large refactor. Cleans up, adds tests, intermediate namespaces
...
Indexes are still broken due to past changes, but intermediate namespaces are
now linkable.
2015-04-14 15:59:09 -07:00
Eric Holscher
c7bef8e11b
Initial commit
2015-03-27 12:50:56 -07:00
