Commit Graph

48 Commits (7230330686a2f5a8314e9d96e52d3a570bc821ba)

Author SHA1 Message Date
Ashley Whetter 7230330686 Documentation overhaul 5 years ago
Ashley Whetter 3b299be332 Tidied up index page 5 years ago
Ashley Whetter a4f798183c Fixed private submodules displaying when private-members turned off
Also fixed whitespace issues in templates.
5 years ago
Ashley Whetter 68e1f79ed5 Added render log messages 5 years ago
Ashley Whetter f77bf19800 Added Black formatting 5 years ago
Ashley Whetter 2cf80b1569 Fixed Sphinx logger deprecation warnings 5 years ago
Ashley Whetter dfe82ae94e Dropped support for Sphinx<1.6 5 years ago
Ashley Whetter 8d4fb4b1c3 Can document a public python API
Closes #153
6 years ago
Ashley Whetter bc65e766c3 Made it easier to remove default index page
Also removed autoapi_add_api_root_toctree config option
because it is less useful now.

Closes #152
6 years ago
Ashley Whetter b19b9ea28b Extended ast parsing with astroid 6 years ago
Sam Lai ea8efe91dc Fix lint errors
There should be no behavioural changes - this is just explicitly returning what would've been returned anyway.
6 years ago
Ashley Whetter b792463cc9 Can turn off autoapisummary directives in output 7 years ago
Ashley Whetter 4adcdc5351 Python documentation is now hierarchical 7 years ago
Ashley Whetter 958fe10103 Added autoapisummary directive 7 years ago
Eric Holscher d803b28d00 Kill janky napolean overlay 7 years ago
Eric Holscher 3531f5560a Merge remote-tracking branch 'origin/master' into cleanup-june 7 years ago
Ashley Whetter 86a9ffdd60 Fixed lint errors 7 years ago
Ashley Whetter ae1e4f556d Fixed usage of deprecated status_indicator
This fixes a compatibiity issue with Sphinx 1.7
7 years ago
Eric Holscher 21a82718ab Fix linting 7 years ago
Eric Holscher 8c1016f8c7 Fix linting 7 years ago
Eric Holscher 4428ecd6e8 Add ability to process Napolean docstrings. 7 years ago
Eric Holscher efb541f78a Add ability to add API to top-level TOC. 7 years ago
Eric Holscher d34af13767 Fix pathing 8 years ago
Eric Holscher aa06999300 Nest the wrapper 8 years ago
Eric Holscher ffb2130b55 Implement prepare_docstring filter that wraps Sphinx's
This allows us to output docstrings in a reasonable fashion.
8 years ago
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
8 years ago
Anthony Johnson a5a34df7f4 Basic cleanup on docstrings, import order 8 years ago
Eric Holscher 8e97201423 A few more PYthon upgrades 8 years ago
Eric Holscher 5e18b65a6c Lots of updates to handle file pathing more sanely. 8 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
Eric Holscher 2958bc34fb Fix linting errors 9 years ago
Eric Holscher 4de4b376ca Rename `autoapi_dir` to `autoapi_dirs` to support multiple 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
Eric Holscher acef865e6f Fix up python 3 support.
This works for everything except epyparse currently.
9 years ago
Eric Holscher 2152ae373b Add support for optionally raising error. 9 years ago
Eric Holscher e00fc127cc Clean up errors caught by linting 9 years ago
Eric Holscher 118fa50e11 Fix circular import 9 years ago
Eric Holscher 095b1e5b29 Add Indentity as the default dotnet testing project.
Also lots of little cleanup to remove errors on those builds.
9 years ago
Eric Holscher 481bf32b15 Match ignore patterns again full filename 9 years ago
Eric Holscher 6f6e09b1f6 Properly handle multiple file patterns. 9 years ago
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.
9 years ago
Eric Holscher 51fe162fb0 Cleanup to address review 9 years ago
Eric Holscher 463816673d Small dotnet updates 9 years ago
Eric Holscher 8770a04bf8 Update dotnet codebase for new tooling 9 years ago
Eric Holscher 685665535f Rename files 9 years ago