Commit Graph

42 Commits

Author SHA1 Message Date
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
Eric Holscher
ba1a09a8d1 Add ability to auto-inject AutoAPI into TocTree 2015-07-07 15:30:16 -07:00
Eric Holscher
f1130fe971 Use titles 2015-06-22 13:51:49 -04:00
Eric Holscher
6b9a9bafdd Rejigger settings 2015-06-22 13:50:30 -04:00
Eric Holscher
5d861d13d8 Clean up handling of python args/params. 2015-06-10 14:37:17 -07:00
Eric Holscher
f60b7d8880 Add ability to configure options of display of objects. 2015-06-10 13:58:52 -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
a838e5333d Default keep_files to off. 2015-06-10 11:36:07 -07:00
Eric Holscher
c02cd9d32e Add testing for template overrides. 2015-06-10 10:33:18 -07:00
Eric Holscher
31924ec371 Merge pull request #8 from rtfd/refactor-top-level
Refactor top level
2015-06-07 08:07:59 -07:00
Eric Holscher
5b9be5791f Fix wording 2015-06-07 08:06:24 -07:00
Eric Holscher
1d3bd2012e Refactor some settings and jinja env. 2015-06-06 13:44:01 -07:00
Anthony Johnson
dedd406b34 Restore proper docs, don't test golang on our docs 2015-06-01 11:34:34 -07:00
Eric Holscher
cdd8d244de Fix up templates 2015-05-29 15:48:58 -07:00
Eric Holscher
9bdd44d8cd Add a basic go domain. 2015-05-29 15:22:06 -07:00
Eric Holscher
eb05b7d991 Swap include 2015-05-29 12:37:06 -07:00
Eric Holscher
c6f2d32305 Add fancy captions 2015-04-24 10:11:05 -07:00
Eric Holscher
f3c5f60fca Add template doc 2015-04-23 15:42:18 -07:00
Eric Holscher
da43e6a03f Lower depth 2015-04-23 15:35:01 -07:00
Eric Holscher
b7b0c9cb7f Fix ref 2015-04-23 15:30:19 -07:00
Eric Holscher
aa62ad9af7 Sizable refactor of the autoapi tooling.
Standard template context and rendering. Also refactor YAML loading for new YAML formats.
2015-04-23 13:31:03 -07:00
Eric Holscher
2f8d1de616 Add a bit more to install 2015-04-22 16:47:50 -07:00
Eric Holscher
20a8cfc8e7 Use autoapi. Meta. 2015-04-22 16:23:57 -07:00
Eric Holscher
8a1fd360a7 New search path 2015-04-22 16:19:51 -07:00
Eric Holscher
96d63676e1 Document default impl 2015-04-22 16:10:53 -07:00
Eric Holscher
7c3ca95ead Add template contract 2015-04-22 16:08:49 -07:00
Eric Holscher
b6bc093faf Clean up header 2015-04-22 15:53:37 -07:00
Eric Holscher
0dd30497b1 Always require 2015-04-22 15:52:22 -07:00
Eric Holscher
4819dfd3f4 Add toctree 2015-04-22 15:50:34 -07:00
Eric Holscher
7023fc6bf8 Remove autogen'd file 2015-04-22 15:49:05 -07:00
Eric Holscher
79f971ed52 Default theme 2015-04-22 15:48:19 -07:00
Eric Holscher
f178316671 Add real docs 2015-04-22 15:46:40 -07:00