Commit Graph

2014 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f2af9ff97c Merge branch 'master' into fix_4035_2 2018-05-06 23:27:51 +09:00
Takeshi KOMIYA
8c430197cc Merge pull request #4934 from tk0miya/update_docs
Update docs (refs: #4875)
2018-05-06 16:37:41 +09:00
Takeshi KOMIYA
8bc136a9cb Use \sphinxcite instead of \cite 2018-05-03 20:58:30 +09:00
Takeshi KOMIYA
304c208d32 Add BibliographyTransform to restruct doctree for LaTeX 2018-05-03 20:54:42 +09:00
Takeshi KOMIYA
5a90e0bc85 Update docs (refs: #4875) 2018-05-03 17:40:32 +09:00
Takeshi KOMIYA
8febb09373 Merge branch 'master' into refactor_latex_footnotes 2018-05-03 11:40:44 +09:00
Takeshi KOMIYA
cbf4ee24f9 Fix #4811: The files under html_static_path are excluded from source 2018-05-03 11:07:14 +09:00
Takeshi KOMIYA
0ea06e40ca Merge branch 'master' into 789_escape_braces_on_samp_role 2018-05-03 01:32:35 +09:00
Takeshi KOMIYA
b90c2576d6 Merge pull request #4880 from tk0miya/refactor_env2
Refactor BuildEnvironment: Move read_doc() method to Builder class
2018-05-01 23:45:21 +09:00
Takeshi KOMIYA
39fe7ee293 refactor: Move env.write_doctree() to Builder._write_doctree() 2018-05-01 23:06:05 +09:00
Takeshi KOMIYA
90949a3b4f refactor: Move env.read_doc() to Builder._read_doc() 2018-05-01 23:06:05 +09:00
Stephen Finucane
0bf8886fc4 doc: Address review comments
These came up in the review for pull request #4799.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:41:12 +01:00
Stephen Finucane
16e76faba3 doc: Add "config" to usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:36:45 +01:00
Stephen Finucane
ac19be3585 doc: Rework "config" document
Wrap some lines and format some definition lists as such.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:36:44 +01:00
Stephen Finucane
d1972ac5b5 doc: Add "markdown" section to usage guide
Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:36:44 +01:00
Stephen Finucane
dcf07f8005 doc: Rework "markdown" 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

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:36:44 +01:00
Stephen Finucane
7a8d1dc08c doc: Fix line length
Keep things in the fixed docs under 80 characters.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-04-30 21:36:44 +01:00
Takeshi KOMIYA
8e6c04c630 Merge branch 'master' into deprecate_highlightlang_directive 2018-04-29 21:13:13 +09:00
Takeshi KOMIYA
a31e7beee7 Merge branch 'master' into refactor_latex_footnotes 2018-04-29 21:09:46 +09:00
Takeshi KOMIYA
4118e8b35b Merge branch 'master' into refactor_config 2018-04-29 19:00:04 +09:00
Takeshi KOMIYA
6b397d1fb1 Show warnings for deprecated html_search_options 2018-04-28 14:34:49 +09:00
Takeshi KOMIYA
a68f772d7a Merge branch 'master' into refactor_config 2018-04-28 13:05:47 +09:00
Takeshi KOMIYA
b165ade6b0 Rename Config.read_from_py() to Config.read() 2018-04-28 13:05:28 +09:00
Takeshi KOMIYA
622119a9d4 Fix #789: `:samp:` role supports to escape curly braces with backslash 2018-04-28 12:56:01 +09:00
Ashley Whetter
44da51a564 Plugins can find source code for viewcode
Fixes #4035
2018-04-24 14:45:16 -07:00
Sumana Harihareswara
3b36ac8f53 Fix PyPI link in theming docs 2018-04-23 09:27:17 -04:00
Takeshi KOMIYA
d505d232de Merge pull request #4884 from tk0miya/4873_adjust_word-break
Fix #4873: Adjust word-break of deprecated-APIs table
2018-04-22 21:31:56 +09:00
Takeshi KOMIYA
d97dc05b37 Fix #4873: Adjust word-break of deprecated-APIs table 2018-04-22 20:00:46 +09:00
Takeshi KOMIYA
5897d45cc6 Merge branch 'master' into refactor_config 2018-04-22 18:56:04 +09:00
Takeshi KOMIYA
bed764316f Merge pull request #4875 from tk0miya/4859_update_docs
doc: Add a note for dotfiles on html_static_path (refs: #4859)
2018-04-22 18:33:39 +09:00
Takeshi KOMIYA
1542622cf7 Merge pull request #4853 from tk0miya/4810_order_of_transforms
Change processing order of reading a document
2018-04-21 19:17:27 +09:00
Takeshi KOMIYA
ed3bc1a87e Merge pull request #4833 from tk0miya/add_docs_for_ImageConverter
doc: Add ImageConverter to utils
2018-04-21 14:44:02 +09:00
Takeshi KOMIYA
6b14cd3bd6 Change priority of versioning doctrees 2018-04-21 11:28:23 +09:00
Takeshi KOMIYA
fdb96bb948 doc: Update about sphinx.ext.imgconverter 2018-04-21 11:21:27 +09:00
Takeshi KOMIYA
ea7d30a190 doc: Add ImageConverter to utils 2018-04-21 11:21:27 +09:00
Takeshi KOMIYA
5a63c2970f doc: Add a note for dotfiles on html_static_path (refs: #4859) 2018-04-21 11:02:46 +09:00
Takeshi KOMIYA
abf8999ce7 Deprecate footnotes helpers 2018-04-20 22:14:49 +09:00
Jon Dufresne
365c93f227 Update all pypi.python.org URLs to pypi.org
For details on the new PyPI, see the blog post:

https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html
2018-04-18 19:51:48 -07:00
Takeshi KOMIYA
b35198d847 Deprecate highlightlang directive
highlightlang directive is not documented, and marked as old in v0.2.
2018-04-15 00:33:02 +09:00
Gussie Carther
390ea6d35a Fix #4420: Docs conflict on use of rst_prolog and rst_epilog 2018-04-14 17:51:06 +09:00
Takeshi KOMIYA
c35eb6fade Merge pull request #4815 from tk0miya/refine_add_css_file
Refine adding CSS files
2018-04-13 00:21:33 +09:00
Takeshi KOMIYA
c12d616be9 Merge pull request #4819 from TimKam/1428-web-support-wrong-static-param-doc
#1428 update websupport API doc
2018-04-12 23:43:31 +09:00
Takeshi KOMIYA
35e4bd498f Merge pull request #4831 from tk0miya/fix_docs
Fix docs
2018-04-12 23:42:35 +09:00
Nicholas Devenish
5685512e6a Add missing literalinclude options documentation
The start-at and end-at options, added in 560b572 for v1.5a1, #625
weren't previously documented. This fixes that.
2018-04-11 18:10:37 +01:00
Takeshi KOMIYA
69624bffa7 doc: Fix filename 2018-04-12 00:49:31 +09:00
Takeshi KOMIYA
5fd7bd7a12 doc: Fix broken link 2018-04-12 00:49:27 +09:00
Takeshi KOMIYA
b2bd9f75a6 Merge branch '1.7' 2018-04-09 01:46:00 +09:00
Takeshi KOMIYA
1dd605971c Merge pull request #4804 from tk0miya/add_SphinxDirective
Add SphinxDirective class
2018-04-08 23:30:19 +09:00
Timotheus Kampik
aa5a7e5916 #1428 further indent note 2018-04-08 13:40:23 +02:00
Timotheus Kampik
841a123c39 #1428 move/indent note 2018-04-08 13:38:53 +02:00