Stephen Finucane
e01e9e34bb
doc: Extend "directives" doc, part 2
...
Continue building up this combined doc by adding the contents of the
former 'code' document. There are no changes to the content.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
0641209da9
doc: Extend "directives" doc, part 1
...
Continue building up this combined doc by adding the contents of the
former 'para' document. There are no changes to the content.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
fdf91e502c
doc: Add "directives" doc to restructuredtext section
...
There's simply no need to artificially divide up the documentation on
directives into multiple, hard-to-navigate documents. Gather all
documentation for directives into one easy-to-reference guide, starting
with the former 'toctree' document. There are no changes to the content.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
0167c009c2
doc: Rework "markup" documents
...
These are going to form the basis of a future 'directive' document, so
we do some cleanup before this happens. There are a number of cleanup
items.
- Some paragraphs are reworded or clarified
- Semantic markup is added where possible
- Everything is wrapped to ~80 characters
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:28 +01:00
Stephen Finucane
08ff8160b8
doc: Add "field-lists" doc to restructuredtext section
...
These are very poorly documented at present, especially given their
power and use in basically all non-Napoleon based Python documentation.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:37:25 +01:00
Stephen Finucane
3fcb1bd2dd
doc: Add "roles" doc to restructuredtext section
...
This is essentially the 'markup/inline' with a few small fixes. There
are also some modifications to the basic rST guide to highlight what a
role is; we were doing this for directives but not roles.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:34:36 +01:00
Stephen Finucane
9c2ab8c3bb
doc: Add "restructuredtext" section to usage guide
...
This is taken from the existing 'rest' documents. Little to no
modifications are necessary, thankfully.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-03-27 15:34:26 +01:00
Takeshi KOMIYA
aa1073cfe1
Fix #4787 : Update docstrings for add_directive()
2018-03-27 23:10:22 +09:00
Takeshi KOMIYA
e2d2a9ab7b
Merge pull request #4774 from tk0miya/4769_argument_for_staticmethods
...
Fix #4769 : autodoc loses the first staticmethod parameter
2018-03-27 09:47:11 +09:00
Takeshi KOMIYA
7aaa4948f5
The dirname
argument for eval_config_file() is now required
2018-03-27 01:33:07 +09:00
Takeshi KOMIYA
2a43b44ec6
Use `cls
` variable to instantiate
2018-03-27 01:29:50 +09:00
Takeshi KOMIYA
0f3fa689a4
Deprecate env._nitpick_ignore
2018-03-26 02:05:58 +09:00
Takeshi KOMIYA
f9ae69d9b0
Drop typing.TYPE_CHECKING
2018-03-26 02:02:19 +09:00
Takeshi KOMIYA
5734d8ad02
Merge pull request #4779 from thomashk0/fix-win-lcmessages
...
Handle missing LC_MESSAGES attribute on Windows
2018-03-26 01:23:00 +09:00
Thomas Hiscock
2d9e7f9baa
Handle missing LC_MESSAGES attribute on Windows
...
This small fix handles the case where LC_MESSAGES is not defined
in Python's locale module (e.g., on Windows).
2018-03-25 11:01:59 +02:00
Takeshi KOMIYA
9e0089b252
Fix #4769 : autodoc loses the first staticmethod parameter
2018-03-24 00:53:07 +09:00
Takeshi KOMIYA
42263a07a6
Merge branch 'master' into add_override_option
2018-03-24 00:44:11 +09:00
Takeshi KOMIYA
69383f83bd
Merge pull request #4768 from cocoatomo/patch-1
...
Minor typo
2018-03-24 00:43:01 +09:00
Takeshi KOMIYA
13455067e8
Fix mypy violations
2018-03-24 00:42:41 +09:00
Takeshi KOMIYA
78cbf96158
Deprecate Config.check_types()
2018-03-24 00:29:11 +09:00
Takeshi KOMIYA
3d8cb12497
Raise ExtensionError from Config class instead application class
2018-03-24 00:27:03 +09:00
Takeshi KOMIYA
e4ecb97d5a
refactor testcase for config
2018-03-23 23:41:09 +09:00
Takeshi KOMIYA
1cce27c302
Refactor: Move correct-copyright-year to config-inited handler
2018-03-23 23:41:09 +09:00
Takeshi KOMIYA
ba83214386
Refactor: Add Config.read() as a constructor
...
To simplify Config.__init__() method, this separates conf.py parsing
feature to Config.read() method.
This allows to instantiate config object simply.
2018-03-23 23:40:28 +09:00
cocoatomo
c0ec1ab23e
Minor typo
2018-03-22 23:20:02 +09:00
Takeshi KOMIYA
f26db5b228
Merge pull request #4742 from tk0miya/refactor_enumerable_nodes
...
Refactor enumerable nodes
2018-03-21 23:41:38 +09:00
Takeshi KOMIYA
41f17aeb21
Merge branch '1.7'
2018-03-21 21:08:31 +09:00
Takeshi KOMIYA
991b471025
Bump version
2018-03-21 21:06:48 +09:00
Takeshi KOMIYA
d029b3d5c9
Bump to 1.7.2 final
2018-03-21 21:03:54 +09:00
Takeshi KOMIYA
f9753e30de
Merge branch '1.7'
2018-03-21 20:55:30 +09:00
Takeshi KOMIYA
ce3019821b
Merge pull request #4766 from tk0miya/4520_apidoc
...
4520 apidoc
2018-03-21 20:00:47 +09:00
Takeshi KOMIYA
a35be4cc66
Update CHANGES
2018-03-21 14:55:09 +09:00
Takeshi KOMIYA
451168d292
Merge pull request #4764 from tk0miya/4744_add_canonical_url
...
Fix #4744 : Add canonical URL to docs
2018-03-21 14:45:15 +09:00
Takeshi KOMIYA
00260936ed
Merge pull request #4762 from tk0miya/4724_fix_example_for_autogen
...
Fix #4724 : doc: an example of autogen is incorrect
2018-03-21 14:42:07 +09:00
Takeshi KOMIYA
2d0e2557b8
Merge branch 'master' into refactor_enumerable_nodes
2018-03-21 14:40:58 +09:00
Takeshi KOMIYA
75eccc86d7
apidoc: Fix local variable is not initialized
2018-03-21 14:36:16 +09:00
Christer Bystrom
a7aac6956d
Closes #4520 - acidic: Subpackage not in toc. The rule of skipping folders with only an empty __init__.py has been removed. The reason for this is that it was never working consistently in the first place and made the code unnecessary hard to reason about. Tests for the TOC generation have been added, as well as tests for the exclude mechanism since they are coupled. One test (test_ext_apidoc.py::test_exclude) has also been modified to reflect the new behaviour.
2018-03-21 14:35:58 +09:00
Takeshi KOMIYA
ad08b5b409
Merge pull request #4755 from stephenfin/issue/4738
...
codecov: Disable status checks
2018-03-21 11:47:03 +09:00
Takeshi KOMIYA
948f8c94d9
Merge pull request #4763 from tk0miya/4611_epubcheck
...
Fix existence check for JRE was broken
2018-03-21 01:23:56 +09:00
Stephen Finucane
cef28eedfe
codecov: Disable status checks
...
We don't currently care if a commit changes our coverage metrics, so we
can disable the status checks that would enforce that.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes : #4738
2018-03-20 15:33:35 +00:00
Takeshi KOMIYA
1a43d47c33
Add a new keyword argument `override
` to Application APIs
2018-03-21 00:23:44 +09:00
Takeshi KOMIYA
d7a9c8638b
Merge pull request #4759 from tk0miya/reduce_the_loglevel_of_message_for_add_translator
...
Reduce the log level of message for add_translator()
2018-03-21 00:10:54 +09:00
Takeshi KOMIYA
a014caa4f0
Merge pull request #4761 from tk0miya/fix_confdir
...
Fix invalid __file__ variable is passed to conf.py
2018-03-21 00:10:23 +09:00
Takeshi KOMIYA
d8c107a61b
Fix #4744 : Add canonical URL to docs
2018-03-21 00:01:44 +09:00
Takeshi KOMIYA
cd08872cc0
Fix existence check for JRE was broken
2018-03-20 23:35:42 +09:00
Takeshi KOMIYA
f6e8b9897d
Reduce the log level of message for add_translator()
...
This message might be useful for developers, not for users.
So I changed it to debug message from info leveled.
2018-03-20 23:10:14 +09:00
Takeshi KOMIYA
cf3de7d62b
Merge pull request #4758 from tk0miya/epub_escape_toc.ncx
...
epub: Fix docTitle elements of toc.ncx is not escaped
2018-03-20 23:08:10 +09:00
Takeshi KOMIYA
9716010313
Merge pull request #4757 from tk0miya/suppress_DeprecationWarning
...
test: Suppress DeprecationWarning
2018-03-20 23:07:37 +09:00
Takeshi KOMIYA
0a8e3f5087
Fix #4724 : doc: an example of autogen is incorrect
2018-03-20 22:58:21 +09:00
Takeshi KOMIYA
4202c13fe8
Fix invalid __file__ variable is passed to conf.py
2018-03-20 22:52:17 +09:00