Commit Graph

40 Commits

Author SHA1 Message Date
Lonami Exo
b716c4fe67 Several documentation enhancements and build warnings fixes
- Made the documentation even more friendly towards newbies.
- Eased the usage of methods like get history which now set
  a default empty message for message actions and vice versa.
- Fixed some docstring documentations too.
- Updated the old normal docs/ to link back and forth RTD.
- Fixed the version of the documentation, now auto-loaded.
2018-01-20 11:47:17 +01:00
Dmitry D. Chernov
6ec6967ff9 Make exception types correspond to Python docs 2017-12-28 09:48:02 +10:00
Lonami Exo
f39d8f132f Make generated description on the docs more friendly 2017-09-29 12:14:09 +02:00
Lonami Exo
9787fb8c46 Add and copy 404.html to the generated docs 2017-09-24 13:40:54 +02:00
Lonami Exo
d5ba259d4e Ensure the working directory is unaltered after generating docs 2017-09-23 21:02:32 +02:00
Lonami Exo
40d80f73ee Enhance docs search to show namespaces if names clash 2017-09-23 21:01:49 +02:00
Lonami Exo
56302552fb Fix formatting URLs on the documentation failing for types 2017-09-23 21:01:06 +02:00
Lonami Exo
d0e66c104a Fix generating documentation failing on root directory 2017-09-23 21:00:01 +02:00
Lonami Exo
97cab7347b Make lint happier 2017-09-04 17:10:04 +02:00
Lonami Exo
eab44af4c0 Show "Methods accepting this type as input" on the docs 2017-07-08 17:31:57 +02:00
Lonami Exo
5f19f22d46 Docs should not let core types be searched 2017-07-08 13:35:10 +02:00
Lonami Exo
4563875ab5 Let constructors be searched on the docs, and allow collapsing types 2017-07-08 13:28:23 +02:00
Lonami Exo
5061e22c66 Update documentation index to reflect __call__ and enhance search 2017-07-07 11:33:24 +02:00
Lonami Exo
1ca41b5854 Automatically infer the value for 'random_id' parameters 2017-06-11 19:16:59 +02:00
Lonami Exo
3de398bae6 Sort constructors on the documentation for predictable results 2017-06-04 20:21:45 +02:00
Lonami Exo
2f00033683 Add a nice button to the docs to copy the import code 2017-06-04 20:21:14 +02:00
Lonami Exo
289baa0fed Show return type on the generated documentation too 2017-05-24 19:23:44 +02:00
Lonami Exo
7eaa393271 Show types containing the current type as a member on docs 2017-05-22 17:30:35 +02:00
Lonami Exo
02a847b64a Make lint happier 2017-05-21 13:59:16 +02:00
Lonami Exo
63c89af983 Use relative imports always where possible 2017-05-21 13:02:54 +02:00
Lonami Exo
ca80b05694 Add shebangs and set proper file permissions 2017-05-20 15:58:44 +02:00
Lonami Exo
4af5085f17 Sort namespaces and types when generating the docs (#87) 2017-05-19 10:36:20 +02:00
Lonami Exo
57d99eabbb Fix docs generating invalid links for Vector results (#87) 2017-05-19 10:01:58 +02:00
Lonami Exo
41d1dac1c6 Fix docs example using non-existing variable (#87) 2017-05-19 09:46:46 +02:00
Lonami Exo
d6bec7481e Use case insensitive search on the docs (#87) 2017-05-19 09:44:15 +02:00
Lonami Exo
ef3cdf9e23 Fix constructor count showing as negative 2017-04-15 15:34:49 +02:00
Lonami Exo
81dfcc4102 Improve the docs navigation 2017-04-15 14:15:40 +02:00
Lonami Exo
ba83edd8f5 Add search to the docs 2017-04-15 13:58:21 +02:00
Lonami Exo
2ecd181c25 Externalize the core index on the docs 2017-04-15 13:23:17 +02:00
Lonami Exo
9428e73891 Core documentation index should really be at the root 2017-04-08 14:07:36 +02:00
Lonami Exo
df7f4bc47c Generate docs to the generated/ subfolder 2017-04-08 14:04:32 +02:00
Lonami Exo
56a959a07d Generate core documentation 2017-04-08 13:58:42 +02:00
Lonami Exo
356ed164f7 Don't link generic arguments on the docs 2017-04-08 12:41:31 +02:00
Lonami Exo
64a1a69a5e Minor visual improvements to the docs 2017-04-08 12:26:48 +02:00
Lonami Exo
877065d0ac Reuse code when writing the docs menu, add menu to indices 2017-04-08 12:21:38 +02:00
Lonami Exo
a4e8b3d2e5 Generate indices files on the documentation 2017-04-07 21:06:49 +02:00
Lonami Exo
edda87b81b Make use of the reusable docs writer class 2017-04-07 20:18:01 +02:00
Lonami Exo
b50a85bb93 Add a more reusable document writer class 2017-04-07 20:07:55 +02:00
Lonami Exo
4abeb0b14a Generate docs for all the types listing their constructors 2017-04-07 19:08:00 +02:00
Lonami Exo
0abeb54a28 Write a documentation generator script 2017-04-07 18:30:54 +02:00