Commit Graph

36 Commits

Author SHA1 Message Date
Brandon Wiebe
6b16e02de4
Let Sphinx handle adding domain directives to the toctree (#374)
* Remove ability to add domains to the toctree

* Add towncrier news fragment
2023-03-28 09:13:28 -07:00
Ashley Whetter
3f8730aadd Fix tests 2023-01-16 21:14:38 -08:00
Bruno P. Kinoshita
c9edd8d1c6
Minor fixes (typos, http->https in links, types) (#348)
* Avoid http->https redirect, use https where possible

* Add autoapi_template_dir to existing array instead of re-declaring

* Typos

* Sphinx util uses int for verbosity in status_iterator

* Sphinx utils uses tuples for TypeField arguments
2022-09-27 12:18:48 -07:00
Kian-Meng Ang
075736619f
Fix typos (#331) 2022-07-25 11:34:17 -07:00
Ashley Whetter
826bb2badd Converted tests to pytest style 2021-04-03 19:01:27 -07:00
Ashley Whetter
5794902b23 Support Sphinx 2.4 and 3.0 2020-04-05 20:03:05 -07:00
danields761
be324b10bf Made dependencies of other languages optional (#171)
* Fixes #170

* Makes sphinxcontrib-golangdomain and
sphinxcontrib-dotnetdomain to be optional
packages
* Adds check that appropriate dependencies of
a specified api-type installed during the
extension initialisation
* Adds appropriate tests
2019-09-01 14:44:17 -07:00
Ashley Whetter
b5d83f8472 Fixed tests 2019-04-06 11:15:18 -07:00
Ashley Whetter
a4f798183c Fixed private submodules displaying when private-members turned off
Also fixed whitespace issues in templates.
2019-03-05 22:52:13 -08:00
Alexander Gor
b94acc6019 Properly pass file patterns to godocjson utility (#161)
* Properly pass  file patterns to godocjson utility

* Go integration tests fixed during to new *ignore* argument
2019-02-20 07:26:20 -08:00
Ashley Whetter
f77bf19800 Added Black formatting 2019-01-26 21:20:45 -08:00
Ashley Whetter
88eea89bb5 Reorganised Python tests to be more pytest-like 2019-01-26 16:18:16 -08:00
Ashley Whetter
c3ef72ee14 Fixed nested classes not getting displayed in autogenerated docs 2018-08-07 14:39:38 -07:00
Ashley Whetter
7dd822eef4 Can still link to public items in private modules 2018-08-06 15:02:01 -07:00
Ashley Whetter
75ebcfc903 private-members also controls private subpackages and submodules
Closes #150
2018-08-06 14:52:42 -07:00
Ashley Whetter
4ac85dd7af Added autoapi directives for Python 2018-08-06 14:19:12 -07:00
Ashley Whetter
9cb2f7d50e Methods include self in their arguments
autodoc does this by default so it makes sense to do it in autoapi also.
2018-08-06 14:19:12 -07:00
Sam Lai
974bae1f20 Support specifying package directories in autoapi_dirs (#135)
* Support specifying package directories as well

Fixes #108.

* Use os.sep instead of the hardcoded '/'

This was making the tests fail on Windows because the necessary '/'
replacements were not happening on Windows due to os.sep being '\\'.
2018-07-03 21:34:31 -07:00
Ashley Whetter
6ca62f16c9 Can control how __init__ docstring is displayed 2018-06-05 22:47:32 -07:00
Ashley Whetter
b19b9ea28b Extended ast parsing with astroid 2018-05-08 22:41:35 -07:00
Ashley Whetter
87baee8998 Added integration tests for napoleon conversions 2017-11-10 14:57:43 -08:00
Ashley Whetter
174e6b8232 Fixed tests under Python 3 2017-11-05 15:03:18 -08:00
Ashley Whetter
a1a3f05202 Fix for Sphinx 1.6 2017-11-05 14:18:43 -08: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
Anthony Johnson
20a1852907 Fix outdated fixture data 2016-03-25 18:17:05 -07:00
Eric Holscher
4de4b376ca Rename autoapi_dir to autoapi_dirs to support multiple 2015-09-23 16:00:43 -07:00
Eric Holscher
220599c22f Attempt to fix path names on Windows. 2015-08-10 20:03:46 -07:00
Eric Holscher
d3b6bd305f Skip epyparse tests on py3 2015-08-04 10:19:18 -07:00
Eric Holscher
801e2e4675 Fix mock 2015-08-03 11:49:18 -07:00
Eric Holscher
cb28412dfd Fix test mocks 2015-07-07 16:32:38 -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
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
a3244a2531 Rename tests to be more descriptive 2015-06-10 11:50:14 -07:00