Ashley Whetter
0a5b84b8be
autoapi_file_patterns is in order of preference
...
Closes #243
2020-08-31 21:18:36 -07:00
Ashley Whetter
9bd08a2bc1
Version 1.4.0
2020-06-07 19:15:13 -07:00
Ashley Whetter
efe815c1df
Fixed a typo in the code of the golang tutorial
...
Closes #207
2020-05-20 19:35:54 -07:00
Ashley Whetter
da8a0d8609
Made the behaviour of autoapi_dirs more clear
2020-05-16 18:38:32 -07:00
Ashley Whetter
8b9f0c23b5
Corrected autoapi_options default value
2020-05-16 18:00:04 -07:00
Ashley Whetter
cd9b9ca0fe
Added the imported-members AutoAPI option
...
Closes #204
2020-05-16 17:36:52 -07:00
Ashley Whetter
b52378fa51
Added autoapi_member_order option
...
Closes #201
2020-05-16 15:28:43 -07:00
Ashley Whetter
e8326cb909
Make template override docs more clear
...
Closes #198
2020-05-14 20:40:43 -07:00
Ashley Whetter
2f87d5ef82
Added __version_info__ and single source version
2020-05-14 20:37:18 -07:00
Matthijs van der Burgh
0e7930e2e0
Fix version in docs conf.py
2020-05-14 20:00:25 -07:00
Matthijs van der Burgh
b8f1ba7cff
Update release process with added version number
2020-05-14 20:00:25 -07:00
Ashley Whetter
0d95377bbf
Accept template directory relative to conf.py
...
Closes #184
2020-04-05 18:50:32 -07:00
Ashley Whetter
4ba45cfacb
Can document inherited members
...
Closes #183
2020-02-01 12:53:40 -08:00
Ashley Whetter
c5d5fb5346
Made passing of options to templates more sane
2020-01-25 17:36:06 -08:00
Ashley Whetter
265b4ae562
Added show-inheritance
...
Also turned autoapi_include_inheritance_graphs into a
show-inheritance-diagram AutoAPI option to be more consistent
with show-inheritance.
Partially implements #183
2020-01-25 14:38:22 -08:00
Ashley Whetter
076427e6ae
Added inheritance diagrams support
...
Close #140
2020-01-11 17:29:36 -08:00
Ashley Whetter
d40122948b
Remaining rtfd -> readthedocs replacements
2020-01-03 12:12:04 -08:00
Ashley Whetter
3a415e2f58
More documentation tweaks
2020-01-03 11:03:17 -08:00
Ashley Whetter
4bccd1bfe7
Documentation tweaks
2020-01-03 09:22:57 -08:00
Olivier Samyn
a836795d17
doc: Add autoapi_python_use_implicit_namespaces config value description
...
+
2020-01-03 08:39:06 -08:00
Ashley Whetter
4c927b2a3f
Minor fix in how_to.rst ( #185 )
2020-01-03 08:33:44 -08:00
Ashley Whetter
2af3d462bf
Fixed formatting of the table in the tutorials
2020-01-03 08:32:15 -08:00
Yuji Tabata
7cc6b72c96
Minor fix in how_to.rst
2019-12-03 13:05:03 +09:00
Ashley Whetter
daa5ce24a5
Version 1.2.1
2019-10-09 20:02:29 -07:00
Ashley Whetter
e06fa71dbc
Version 1.2.0
2019-10-05 17:01:36 -07:00
Ashley Whetter
b8fddf9c0b
Added some missing documentation
2019-10-05 16:05:37 -07:00
Ashley Whetter
900072e99b
Added documentation for optional dependencies
2019-09-07 17:25:03 -07:00
Martín Gaitán
6b6aae95fc
fix typo on subsection's title ( #167 )
2019-07-02 16:18:08 -07:00
Ashley Whetter
0b947a028e
v1.1.0
2019-06-23 13:43:28 -07:00
Ashley Whetter
9735f43a8d
v1.0.0
2019-04-24 15:04:37 -07:00
Ashley Whetter
7230330686
Documentation overhaul
2019-04-21 15:38:22 -07:00
Ashley Whetter
3722490c36
v0.7.1
2019-02-04 21:24:18 -08:00
Ashley Whetter
30a620e449
v0.7.0
2019-01-30 21:57:13 -08:00
Ashley Whetter
9397c0709f
Fixed a typo in the docs
2018-12-04 17:42:30 -08:00
Ashley Whetter
f8c26b2682
v0.6.2
2018-11-15 14:02:17 -08:00
Ashley Whetter
9f197afa76
v0.6.1
2018-11-14 22:50:14 -08:00
Ashley Whetter
cb032b6920
v0.6.0
2018-08-20 11:19:29 -07:00
Ashley Whetter
03f601ed41
Updated documentation
...
Closes #120
2018-08-10 09:01:21 -07:00
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
2018-08-06 16:23:33 -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
Eric Holscher
7f6b47b86d
Bump to version 0.5
2017-11-13 08:29:06 -08:00
Ashley Whetter
b792463cc9
Can turn off autoapisummary directives in output
2017-11-09 12:48:21 -08:00
Brian Madden
defbfc517a
fix typo in templates.rst
2017-05-03 23:01:50 -05:00
Anthony Johnson
04805b5044
Fix version number
...
The module is actually 0.4 release currently. This is not a new release however,
so updated to match 0.4, no additional increment necessary yet.
2016-10-25 16:30:59 -07:00
Anthony Johnson
bcee7eb22a
Use autoapi_root for url root configuration
2015-10-28 11:04:23 -07:00
Eric Holscher
95154786ac
Update docs
2015-09-23 16:02:11 -07:00
Eric Holscher
b471a7dab1
Update docs
2015-09-23 16:01:34 -07:00
Eric Holscher
94757e5dfd
Update sphinx version too
2015-09-05 15:57:28 -05:00
Eric Holscher
6ae1ddaf42
Add docs for file patterns
2015-07-07 16:40:24 -07:00