Dan Abdinoor
83c9380299
Fix links to sphinx-build man page
...
Swap``program`` for ``doc`` links to sphinx-build man page.
2018-07-10 12:14:45 -04:00
Takeshi KOMIYA
1140e81df7
Merge remote-tracking branch 'stephenfin/doc-rework'
2018-06-26 01:05:19 +09:00
Takeshi KOMIYA
1ebf6d4983
Merge pull request #5111 from stephenfin/tox-fixes
...
Run everything but unit tests under Python 3
2018-06-26 00:59:36 +09:00
Takeshi KOMIYA
1a477397b2
Merge pull request #5120 from blueyed/fix-doc
...
doc: fix list with add_object_type
2018-06-26 00:40:22 +09:00
Takeshi KOMIYA
148b47168c
Merge pull request #5123 from blueyed/doc-fixes
...
doc: fix func/meth references to Sphinx
2018-06-25 22:28:37 +09:00
Daniel Hahler
8f94429a21
doc: fix func/meth references to Sphinx
2018-06-25 08:25:56 +02:00
Daniel Hahler
c2b85b923f
doc: fix list with add_object_type
...
This seems to have been accidentally broken in eaaab75ec
.
2018-06-25 06:38:32 +02:00
Takeshi KOMIYA
e1201f2779
Merge pull request #5115 from althonos/patch-1
...
Update napoleon docs with features from #4613
2018-06-23 13:16:05 +09:00
Takeshi KOMIYA
6714e034ac
Merge pull request #5001 from tk0miya/1431_latex_enumlist
...
Close #1431 : latex: Add alphanumeric enumerated list support
2018-06-22 02:28:26 +09:00
Takeshi KOMIYA
41b250c804
Fix flake8 violation
2018-06-22 00:55:07 +09:00
Takeshi KOMIYA
f518d26e45
Merge branch 'master' into 1431_latex_enumlist
2018-06-22 00:27:49 +09:00
Takeshi KOMIYA
3d180f9385
Merge branch '1.7'
2018-06-21 23:23:30 +09:00
Stephen Finucane
3eb26a3335
travis: Run flake8 against Python 3.6
...
As with tox and make before it, we run everything that we can against
Python 3 (Python 3.6 in this case).
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-21 15:11:42 +01:00
Stephen Finucane
2a4827af4f
make: Default to Python 3
...
As with the tox change, it makes sense to test things against Python 3
by default now, seeing as that will be the only version supported in
Sphinx 2.0.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-21 15:11:35 +01:00
Martin Larralde
b2a46c5af9
Add documentation change to changelog
2018-06-21 14:24:28 +02:00
Martin Larralde
14ecf47296
Add @althonos to contributors
2018-06-21 14:23:45 +02:00
Martin Larralde
a68298b7d8
Update napoleon docs with features from #4613
2018-06-21 14:10:52 +02:00
Takeshi KOMIYA
f14d60dcd2
Merge pull request #5096 from tk0miya/update_docs
...
doc: update URL of PDF and EPUB
2018-06-21 01:29:42 +09:00
jfbu
dbb04d0a33
Obide by Docutils `node['prefix']
and
node['suffix']
`
2018-06-20 18:11:11 +02:00
Takeshi KOMIYA
e78133a83e
Merge pull request #5106 from tk0miya/5104_broken_apidoc_main
...
Fix #5104 : apidoc: Interface of ``sphinx.apidoc:main()`` has changed
2018-06-20 22:14:01 +09:00
Takeshi KOMIYA
f54d886a61
Merge branch '1.7' into 5104_broken_apidoc_main
2018-06-20 22:01:25 +09:00
Takeshi KOMIYA
6e27f6c336
Merge pull request #5107 from tk0miya/5070_epub_wrong_anchor
...
Fix #5070 : epub: Wrong internal href fragment links
2018-06-20 21:42:20 +09:00
Stephen Finucane
93589a3572
tox: Run everything but unit tests under Python 3
...
The demise of Python 2.7 is not far off and we intend to drop support
for it in Sphinx 2.0. As a result, there probably isn't a better time
than now to start testing with Python 3 by default. There are a couple
of advantages to this:
- flake8 is stricter under Python 3 and we don't need to ignore files
with Python 3 syntax
- We get to dogfood Sphinx against its own documentation using Python 3
- pylint gains support for Python 3 syntax
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:53:29 +01:00
Stephen Finucane
c0f42b6519
Escape raw strings
...
These were resulting in the below warning messages when running flake8
under Python 3.6.
:48: DeprecationWarning: invalid escape sequence \[
:143: DeprecationWarning: invalid escape sequence \-
:250: DeprecationWarning: invalid escape sequence \s
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:51:55 +01:00
Stephen Finucane
d9ccc95717
doc: Add "extensions" to usage guide
...
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:30:47 +01:00
Stephen Finucane
0b81af6a2e
doc: Rework "extensions" documents
...
This is mostly spacing and other "niceness" fixes.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:26:59 +01:00
Stephen Finucane
b595c4a45b
doc: Add "builders" to usage guide
...
This is placed in a directory as this document will eventually be split
up. However, this is not the day to do this.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:26:59 +01:00
Stephen Finucane
7e27e09493
doc: Rework "builders" document
...
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
A number of TODOs are inserted. These will be resolved separately.
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-06-20 09:26:59 +01:00
Takeshi KOMIYA
f61593b535
Merge pull request #5097 from tk0miya/5035_qthelp_namespace_allows_dashes
...
Close #5035 : qthelp builder allows dashes in :confval:`qthelp_namespace`
2018-06-20 10:13:11 +09:00
Takeshi KOMIYA
2f91a2c22e
Merge branch 'master' into 5035_qthelp_namespace_allows_dashes
2018-06-20 00:45:34 +09:00
Takeshi KOMIYA
75248d1ed1
Update CHANGES for PR #5072
2018-06-20 00:44:45 +09:00
Takeshi KOMIYA
e9701c22e5
Merge pull request #5072 from blueyed/save-env-always
...
Builder.build: save env also with only new documents
2018-06-20 00:43:11 +09:00
Takeshi KOMIYA
fd8e0be57a
Merge branch '1.7'
2018-06-19 23:39:23 +09:00
Takeshi KOMIYA
d7bf78f3ff
Fix #5070 : epub: Wrong internal href fragment links
2018-06-19 23:37:37 +09:00
Takeshi KOMIYA
e1a87ba073
Fix broken testcase by alabaster-0.711
2018-06-19 23:36:54 +09:00
Takeshi KOMIYA
1dffeba0bc
Merge pull request #5102 from tk0miya/update_docs3
...
doc: Use badge to show latest release
2018-06-19 23:35:42 +09:00
Takeshi KOMIYA
b84240d871
Merge pull request #5108 from tk0miya/alabaster-0.711
...
Alabaster 0.711
2018-06-19 23:35:17 +09:00
Takeshi KOMIYA
87ddb6c68f
Fix broken testcase by alabaster-0.711
2018-06-19 22:55:05 +09:00
Takeshi KOMIYA
fb7267aafe
Merge pull request #5095 from tk0miya/5091_latex_curlybrace_in_index
...
Fix #5091 : latex: curly braces in index entries are not handled correctly
2018-06-19 21:12:57 +09:00
Takeshi KOMIYA
b6904e69af
Merge branch '1.7' into 5091_latex_curlybrace_in_index
2018-06-19 09:46:20 +09:00
Takeshi KOMIYA
aa42bb34d2
Merge pull request #5094 from tk0miya/5066_sidebars_for_alabaster
...
Fix #5066 : html: "relations" sidebar is not shown by default
2018-06-19 09:45:17 +09:00
Takeshi KOMIYA
a61986256a
Fix #5104 : apidoc: Interface of `sphinx.apidoc:main()
` has changed
2018-06-18 21:48:03 +09:00
Takeshi KOMIYA
d78fc78a74
Merge pull request #5085 from tk0miya/4362_dont_overwrite_latex
...
Fix #4362 : latex: Don't overwrite .tex file if document not changed
2018-06-17 22:02:21 +09:00
Takeshi KOMIYA
58e1067ccd
Merge branch 'master' into 4362_dont_overwrite_latex
2018-06-17 17:50:49 +09:00
Takeshi KOMIYA
1fc475cfde
Merge pull request #5101 from tk0miya/5100_html_search_has_been_broken
...
Fix #5100 : Fix HTML search has been broken
2018-06-17 17:49:23 +09:00
Takeshi KOMIYA
213ebe7d62
Merge pull request #5103 from jakobandersen/doc-makefile-python
...
Customizable Python interpreter in doc/Makefile
2018-06-17 17:48:44 +09:00
Jakob Lykke Andersen
cff1146775
Customizable Python interpreter in doc/Makefile
...
Fix after previous stray edit.
2018-06-17 09:57:52 +02:00
Takeshi KOMIYA
0e8fb2dd25
doc: update download URL for PDF and EPUB
2018-06-17 16:55:18 +09:00
Takeshi KOMIYA
248869e2db
doc: Use badge to show latest release
2018-06-17 16:45:58 +09:00
shimizukawa
3d6c7d147d
update CHANGES. refs #5083
2018-06-17 15:39:32 +09:00