IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
12,245 Commits 2 Branches 219 Tags 163 MiB
55a89196e4
Commit Graph

2281 Commits

Author SHA1 Message Date
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
Timotheus Kampik
39678b7a61 #1428 update websupport API doc 
* ``staticdir`` was not correctly documented
* ```staticroot`` was not correctly documented at all
 2018-04-07 17:24:50 +02:00
Takeshi KOMIYA
bd2967f1d2 Add :confval:epub_css_files 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
5efecd2150 Add :confval:html_css_files 2018-04-06 13:11:24 +09:00
Takeshi KOMIYA
3afc72fba4 Rename add_stylesheet() to add_css_file() 2018-04-06 13:11:24 +09:00
jfbu
e81f80880a Slight rework of latex doc 2018-04-02 19:47:57 +02:00
jfbu
5473851e8c Improve formatting of docs about LaTeX builder 2018-04-02 19:23:13 +02:00
Takeshi KOMIYA
6030e7390d
Merge pull request #4800 from tk0miya/drop_document.settings.gettext_compact 
Drop `document.settings.gettext_compact`
 2018-04-02 22:58:05 +09:00
Takeshi KOMIYA
47918f365e Merge branch 'master' into refactor_config 2018-04-02 10:47:47 +09:00
shimizukawa
eb1e8f937c So far, the Sphinx-doc project name on the transifex service included the latest major version number. For example "sphinx-doc-1_8". For this reason, we released a major version, we had to create a new project with transifex and took time to switch the data to be translated. This was to keep the translated text of the past version on transifex. 
From now on, transifex project name does not include version number like "sphinx-doc". Project data always handles the contents of Sphinx's master branch.
Translation of the major version of the past is held at https://travis-ci.org/sphinx-doc/sphinx-doc-translations.
 2018-04-01 21:50:13 +09:00
Takeshi KOMIYA
bc63dc8450 Rename Config.read() to Config.from_conf_py() 2018-04-01 20:07:45 +09:00
jfbu
525f3bd104 Typo from #4801 2018-04-01 11:39:58 +02:00
jfbu
a831d6da53 Docs of fonts for LaTeX builds 2018-03-30 23:05:42 +02:00
jfbu
bfdf0d1e83 Merge branch '1.7' 2018-03-30 22:50:55 +02:00
Takeshi KOMIYA
c5e811459e
Merge pull request #4801 from timgraham/add-links 
Add section labels for intersphinx
 2018-03-31 00:10:03 +09:00
Takeshi KOMIYA
ab04a55dbf Add document for utility classes 2018-03-31 00:05:03 +09:00
jfbu
d8b9baf1cb Better font config for Sphinx own PDF docs 2018-03-30 10:32:08 +02:00
jfbu
98e73ecf77 Improve latex docs about fonts 2018-03-30 10:30:05 +02:00
jfbu
9a20927593 Improve choice of lexers for highlighting in Installing Sphinx (docs) 
cf http://pygments.org/docs/lexers/#lexers-for-various-shells

The difference with prior situation shows more in PDF output (but for
Windows example visible already in html) than in HTML with used theme. I
am not sure why ``select`` is highlighted but not ``sudo`` but this was
case already before.
 2018-03-30 09:13:50 +02:00
Takeshi KOMIYA
962b6d459e Drop document.settings.gettext_compact 2018-03-30 13:06:11 +09:00
jfbu
39ce9d9ab9 Fix Unicode Character U+229E (SQUARED PLUS) breaks Sphinx docs in LaTeX 
refs: PR #4794
 2018-03-30 00:11:17 +02:00
Jean-François B
034e69fe73
Merge pull request #4793 from jfbu/larger_typeface_in_xetex_code_blocks 
Let LaTeX with XeTeX/LuaTeX use normal sized typeface in code-blocks
 2018-03-29 23:43:25 +02:00
Tim Graham
725d20b0f9 Add section labels for intersphinx 2018-03-29 13:23:39 -04:00
Takeshi KOMIYA
448db58d88
Merge pull request #4760 from tk0miya/add_override_option 
Add a new keyword argument ``override`` to Application APIs
 2018-03-29 23:26:08 +09:00
jfbu
3839d74aa8 Typo (Sphinx version number wrong in documentation of `'fvset'` key) 2018-03-29 15:22:34 +02:00
Takeshi KOMIYA
90c55f387a
Merge pull request #4794 from kenyon/patch-1 
installation.rst: correct Windows Run keyboard shortcut
 2018-03-29 22:19:20 +09:00
Takeshi KOMIYA
72a0896bd0 Merge branch 'master' into add_override_option 2018-03-29 22:03:05 +09:00
Takeshi KOMIYA
c644ad7cae
Merge pull request #4700 from stephenfin/doc-rework 
Doc rework (user guide, part 3)
 2018-03-29 22:00:09 +09:00
Takeshi KOMIYA
61828786a6 Deprecate app.override_domain() 2018-03-29 21:59:29 +09:00
Takeshi KOMIYA
a24601aa24 Deprecate Config.check_unicode() 2018-03-29 10:32:49 +09:00
Kenyon Ralph
7581e90dce
installation.rst: correct Windows Run keyboard shortcut 
You type Windows-R to get the Run dialog, not Control-R.
 2018-03-28 18:04:05 -07:00
jfbu
8c55793902 Let LaTeX with XeTeX/LuaTeX not use small typeface in code-blocks 
closes: #4791
 2018-03-28 23:17:34 +02:00
Takeshi KOMIYA
febca7cf26 Merge branch 'master' into refactor_config 2018-03-28 01:01:03 +09:00
Stephen Finucane
2565195a44 doc: Add "domains" doc to usage guide 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-03-27 15:37:28 +01:00
Stephen Finucane
893a7ac1f2 doc: Rework "showing code" section 
This makes the section more consistent with the rest of the document.
This adds a new section to the basics guide for doctest blocks, which
are a docutils thing. It also update the default highlight language,
which is now 'default'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-03-27 15:37:28 +01:00
Stephen Finucane
ecd193cde8 doc: Extend "directives" doc, part 3 
Finish building up this combined doc by adding the contents of the
former 'misc' 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
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
0f3fa689a4 Deprecate env._nitpick_ignore 2018-03-26 02:05:58 +09:00
Takeshi KOMIYA
78cbf96158 Deprecate Config.check_types() 2018-03-24 00:29:11 +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
f9753e30de Merge branch '1.7' 2018-03-21 20:55:30 +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
d8c107a61b Fix #4744: Add canonical URL to docs 2018-03-21 00:01:44 +09:00
Takeshi KOMIYA
0a8e3f5087 Fix #4724: doc: an example of autogen is incorrect 2018-03-20 22:58:21 +09:00
Takeshi KOMIYA
2c7d08ee47 Merge branch '1.7' 2018-03-19 23:46:15 +09:00
Takeshi KOMIYA
0ad232696a Update docs (refs: #2307) 2018-03-19 00:23:58 +09:00
Takeshi KOMIYA
52ed9ef3a0 Closes #2157: helper function `warning()` for HTML themes is added 2018-03-19 00:18:10 +09:00
jfbu
bde42595c6 Update installation docs 2018-03-17 22:56:53 +01:00
Takeshi KOMIYA
9efaf18852 Merge branch '1.7' 2018-03-18 01:21:01 +09:00
shimizukawa
e3470bbde3 fix #4734: Describe how to specify make.bat parameter on Windows 2018-03-16 16:19:39 +09:00
Takeshi KOMIYA
b3cbfc2bb5 Update deprecation list 2018-03-15 01:57:39 +09:00
Takeshi KOMIYA
e2f481c956 Merge branch '1.7' 2018-03-03 20:03:45 +09:00
Takeshi KOMIYA
d7bfef13bf
Merge pull request #4690 from tk0miya/1598_awesome_sphinxdoc 
doc: Add a reference to awesome-sphinxdoc
 2018-03-03 01:26:27 +09:00
Takeshi KOMIYA
c0a6795a0f
Merge pull request #4590 from stephenfin/doc-rework 
Doc rework (user guide, part 2)
 2018-03-02 01:59:51 +09:00
Takeshi KOMIYA
bd898be3fc doc: Add deprecation list 
So far, deprecated APIs are only listed as CHANGES entry.  But
they are not listed in one place.  In this change, I gathered them
to docs as a list.
As a side effect, it makes CHANGES entry simple.
 2018-03-02 00:01:49 +09:00
Takeshi KOMIYA
278577c2ef
Merge branch 'master' into improve_i18n 2018-03-01 23:38:38 +09:00
Takeshi KOMIYA
7841de4a26 doc: Add a reference to awesome-sphinxdoc 2018-03-01 00:46:36 +09:00
Stephen Finucane
ff579b3c66 doc: Add "quickstart" doc to usage guide 
This is simply the former 'tutorial' document renamed. A number of
references need to be updated, so this is done.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-26 11:36:46 +00:00
Stephen Finucane
4bc03706e8 doc: Rework "tutorial" document 
We're going to use this document as the basis for a future usage
document, so we start by cleaning things up beforehand. A couple of
changes are necessary:

- The installation guide is referenced, rather than duplicating the
  steps

In addition, there is 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-02-26 11:36:36 +00:00
Takeshi KOMIYA
b3e7609a80 Update docs 2018-02-25 23:44:38 +09:00
Takeshi KOMIYA
6e89c7c906
Merge pull request #4671 from TimKam/4244-show-intersphinx-db 
Document: showing links & targets of Intersphinx mapping file
 2018-02-25 11:32:55 +09:00
Timotheus Kampik
e464f6f135 #4188 update quickstart doc 2018-02-24 17:45:00 +01:00
Timotheus Kampik
20dcbd367d #4244 use more generic Python *3* examples 2018-02-24 16:45:04 +01:00
Timotheus Kampik
7aaba1758a #4244 docs: showing links & targets of Intersphinx mapping 2018-02-24 16:30:09 +01:00
Timotheus Kampik
3700a24e1a #4244 update Python version in intersphinx doc examples 2018-02-24 16:03:01 +01:00
Takeshi KOMIYA
f6b1abf254
Merge pull request #4594 from tk0miya/4564_rst_prolog_not_working 
Change interface of add_source_parser() and add add_source_suffix()
 2018-02-22 20:19:13 +09:00
ederag
359050d88c
Typo: cocstring => docstring 2018-02-21 21:04:54 +01:00
Takeshi KOMIYA
5789b25847 Change interface of add_source_parser() and add add_source_suffix() 2018-02-21 10:54:49 +09:00
Takeshi KOMIYA
4a03c5eeba doc: create htmlhelp section 2018-02-19 10:37:06 +09:00
Aaron Carlisle
8ef71551cb
Docs: Templating: Small wording fix 2018-02-16 18:58:47 -05:00
Stephen Finucane
cb4b7177d8 doc: Create usage guide section 
Start structuring our docs a little better starting with a usage guide.
There are a number of changes happening here. We're going to start with
the installation guide, which is simply moved to the appropriate
subdirectory.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-02-10 16:22:44 +00:00
Stephen Finucane
4fa7d6037c doc: Rework "install" document 
This is a large rework of the installation guide. There are a couple of
changes necessary:

- 'Mac OSX' is replaced by 'macOS'
- PyPI installation steps are moved to their own section
- Instructions are no longer provided for installing Python on Windows:
instead, we refer to the other, better-maintained guides.

In addition, 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-02-10 16:22:40 +00:00
Danish Prakash
0fe14c3e3b
potential typo 
`You can also download PDF/EPUB versions of the Sphinx documentation: a PDF version generated from the LaTeX Sphinx produces, and an EPUB version.`

Either a typo or maybe wrong sentence structure.
 2018-02-06 11:09:48 +05:30
Takeshi KOMIYA
4647fcee45 Merge branch '1.7-release' 2018-01-31 20:40:56 +09:00
Takeshi KOMIYA
9a1de16b90
Merge branch 'master' into register_author_as_confval 2018-01-31 01:46:03 +09:00
Takeshi KOMIYA
a5fea73d0c Merge branch 'master' into integrate_source_suffix_and_source_parsers 2018-01-31 00:04:11 +09:00
Takeshi KOMIYA
8b070366e2 Add links to HTML themes index 2018-01-30 23:40:00 +09:00
Takeshi KOMIYA
41769f1e30 config: epub_authr and epub_publisher refers author by default 2018-01-29 23:29:57 +09:00
Takeshi KOMIYA
23741ca693 Add :confval:author as a configuration value 2018-01-29 23:29:54 +09:00
Takeshi KOMIYA
0010179d45 docs: Add description for attributes of Builder (refs: #4402) 2018-01-29 22:41:06 +09:00
Takeshi KOMIYA
0f4a4b2ae9
Merge pull request #4486 from tk0miya/4460_env_version_of_extensions 
Close #4460: extensions should return the version of data structure as metadata
 2018-01-28 21:15:07 +09:00
Takeshi KOMIYA
686de7dfff
Merge branch 'master' into drop_rst2pdf_support 2018-01-28 19:23:18 +09:00
Takeshi KOMIYA
9f5c676322 Use flake8-import-order 2018-01-28 01:52:16 +09:00
Takeshi KOMIYA
53096a35d8 doc: Fix typo 2018-01-26 01:29:52 +09:00
Takeshi KOMIYA
32c5e8346f Close #4460: extensions should return the version of data structure as metadata 2018-01-25 02:04:22 +09:00
Takeshi KOMIYA
69f69628ed :confval:source_suffix allows a mapping fileext to file types 2018-01-25 02:03:56 +09:00
Takeshi KOMIYA
dc45877d3c Deprecate config value: source_parsers 2018-01-25 02:03:56 +09:00
Takeshi KOMIYA
cfd9528879
Merge pull request #4466 from kurtmckee/update-install-docs 
Update install docs
 2018-01-22 00:12:17 +09:00
Stephen Finucane
487480ca01 doc: Add 'is_parallel_allowed' 
This is an important function and should be documented.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:37:59 +00:00
Stephen Finucane
6c23dac5a6 doc: Reorder 'sphinx.application' docs to match code 
Use the same ordering to minimize cognitive load.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:19:52 +00:00
Stephen Finucane
b7ff955472 doc: Move 'sphinx.application' API docs to code 
This allows us to do something like 'help(sphinx.application)' in code.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 11:19:46 +00:00
Stephen Finucane
eaaab75ec2 doc: Rework 'sphinx.application' API documentation 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-21 10:49:38 +00:00
Takeshi KOMIYA
9a3f401c46 Merge branch '1.7-release' 2018-01-21 16:07:14 +09:00
Takeshi KOMIYA
6e420e517e
Merge pull request #4465 from tk0miya/improve_config 
Improve config
 2018-01-21 16:05:34 +09:00
Takeshi KOMIYA
eaa44779d5
Merge branch '1.7-release' into sphinx-build-set-proc-count-to-cpu-count 2018-01-21 15:43:17 +09:00
Takeshi KOMIYA
1c3865b190
Merge pull request #4469 from kurtmckee/use-https-urls 
Use HTTPS URL's
 2018-01-21 13:11:12 +09:00
Stephen Finucane
78a44b5825 doc: Resolve inconsistent 'sphinx-apidoc' docs 
The signature for the 'sphinx-apidoc' call differs between the man page
and the output of 'sphinx-apidoc --help'. Resolve this by considering
the 'sphinx-apidoc --help' output the canonical reference.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes: #4451
 2018-01-20 23:02:18 +00:00
Kurt McKee
beefd445c1 Convert doc HTTP links to HTTPS, even in documentation examples 
A small number of URL's redirected, or were stale but had obvious
alternatives. These have been updated. For example, a Google style
guide for Python was no longer available at googlecode.com, and
Paver docs are now at readthedocs.io.
 2018-01-20 16:50:35 -06:00
Kurt McKee
c0ffcba9e2 Update the screenshots and docs to match the Python website and installer 
The instructions for installing pip are no longer relevant and have
been removed. The instructions for modifying the PATH are no longer
relevant and have been removed. The final section, "Installing Sphinx
with pip", is now a subsection of the Windows install instructions.
The verb tense has been modified to match the rest of the instructions.
The command line examples have been converted to use the Pygments text
lexer instead of the batch lexer, which highlights everything after `>`
incorrectly.
 2018-01-20 10:07:56 -06:00
Kurt McKee
3620d85b80 Update the Sphinx version to 1.6 2018-01-20 09:59:50 -06:00
Kurt McKee
f70fcabb7c Update the MacPorts URL to use HTTPS 2018-01-20 09:57:28 -06:00
Stephen Finucane
b215f523f7 doc: Move sphinx.logging API docs to code 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-20 13:00:43 +00:00
Stephen Finucane
b7749c6ca3 doc: Move sphinx.config API docs to code 
Once again, we make things a little smarter by using Python domain
roles.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-20 12:53:45 +00:00
Stephen Finucane
391cd8195b doc: Move sphinx.errors API docs to code 
This allows us to do something like 'help(sphinx.errors)' in code. We
reword the exception descriptions per Python stdlib conventions.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-20 12:47:49 +00:00
Takeshi KOMIYA
a331e90c87 doc: Remove mentions to rst2pdf 2018-01-20 21:33:09 +09:00
Takeshi KOMIYA
29df3a095a Add config-inited event 2018-01-20 21:21:45 +09:00
Takeshi KOMIYA
ae620e16f7 doc: Fix typo 2018-01-20 21:09:51 +09:00
deoren
c808b4b8db minor typo 2018-01-16 15:09:45 -06:00
Takeshi KOMIYA
1d0a087f75
Merge branch 'master' into body-width 2018-01-15 10:19:01 +09:00
Takeshi KOMIYA
18dfe37f8c Enable text_add_secnumbers by default (refs: #4218) 2018-01-15 00:37:32 +09:00
Takeshi KOMIYA
b688941b09
Merge branch 'master' into feature-text-secnumbers 2018-01-15 00:21:50 +09:00
Takeshi KOMIYA
c399357f38 Show a notice if both tabularcolumns and :widths: are given (refs: #4196) 2018-01-14 22:23:18 +09:00
Takeshi KOMIYA
cdb31585a8 Merge branch 'master' into sphinx-build-set-proc-count-to-cpu-count 2018-01-14 09:39:48 +09:00
Takeshi KOMIYA
decbf20ccf
Merge pull request #4354 from stephenfin/builder-success-message 
Add 'Builder.epilog' attribute
 2018-01-13 18:39:29 +09:00
Takeshi KOMIYA
840b5828e7 docs: Add `-j auto` option 2018-01-13 15:50:26 +09:00
Takeshi KOMIYA
7e365d97ac
Merge pull request #4235 from anarcat/manpage-links 
add link to manpages in HTML builder
 2018-01-13 14:28:11 +09:00
Takeshi KOMIYA
f5b1aff2d1
Merge branch 'master' into 4183_follow_pep440 2018-01-13 13:12:32 +09:00
Takeshi KOMIYA
12a8d5c0bd doc: make looks understandable 2018-01-13 11:09:27 +09:00
Takeshi KOMIYA
76c5395c5b Merge remote-tracking branch 'atodorov/inheritance_top_class' 2018-01-13 11:08:31 +09:00
deoren
32aa664bdf Small label/comma fix 2018-01-11 15:19:04 -06:00
Stephen Finucane
a83e8bab7d builders: Add 'Builder.epilog' option 
This allows builders to emit a final epilog message containing
information such as where resulting files can be found. This is only
emitted if the build was successful.

This allows us to remove this content from the 'make_mode' tool and
the legacy 'Makefile' and 'make.bat' templates. There's room for more
dramatic simplification of the former, but this will come later.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-01-11 20:57:03 +00:00
Antoine Beaupré
90f7c7ef3f
add link to manpages in HTML builder 
It is useful to have the HTML documentation builder actually link to
real rendered versions of HTML manpages in its output. That way people
can click on manpages to get the full documentation. There are a few
services offering this online, so we do not explicitly enable one by
default, but the Debian manpages repository has a lot of the manpages
pre-rendered, so it is used as an example in the documentation.

The parsing work is done by a transformer class that parses manpage
objects and extract name/section elements. Those then can be used by
writers to cross-reference to actual sites. An implementation is done
in the two HTML writers, but could also apply to ePUB/PDF writers as
well in the future.

This is not enabled by default: the `manpages_url` configuration item
needs to be enabled to point to the chosen site. The `page`, `section`
and `path` parameters are expanded through Python string formatting in
the URL on output.

Unit tests are fairly limited, but should cover most common use-cases.
 2018-01-11 13:20:34 -05:00
Takeshi KOMIYA
38857f97af
Merge pull request #4388 from tk0miya/master 
stable to master
 2018-01-08 21:07:16 +09:00
Takeshi KOMIYA
b6e38b4065
Merge pull request #4310 from tk0miya/refactor_AutoDirective 
Refactor AutoDirective
 2018-01-08 14:38:47 +09:00
Takeshi KOMIYA
1c0a5ee55d Merge branch 'master' into refactor_AutoDirective 2018-01-08 14:17:08 +09:00
Takeshi KOMIYA
7ba54500fc Fix #4183: doctest: `:pyversion:` option also follows PEP-440 specification 2018-01-08 11:59:50 +09:00
Jon Dufresne
cc3abba171 Prefer https & readthedocs.io instead of readthedocs.org for links 
Read the Docs moved hosting to readthedocs.io instead of
readthedocs.org. Fix all links in the project.

For additional details, see:

https://blog.readthedocs.com/securing-subdomains/

> Starting today, Read the Docs will start hosting projects from subdomains on
> the domain readthedocs.io, instead of on readthedocs.org. This change
> addresses some security concerns around site cookies while hosting user
> generated data on the same domain as our dashboard.
 2018-01-07 09:10:27 -08:00
Takeshi KOMIYA
d9ae68b2ee Merge branch 'stable' 2018-01-07 12:16:17 +09:00
Tim Hoffmann
bbfcb2443d cleanup formatting of some sidebar items 2018-01-06 17:49:27 +01:00
Tim Hoffmann
bf29ffb284 #4246: Limit width of text body for all themes 2018-01-06 16:52:12 +01:00
jfbu
bd139453c9 Move SphinxSmartQuotes transform to SphinxStandaloneReader 
closes #4142
closes #4357
closes #4359
refs: #3967

Adds ``smartquotes``, ``smartquotes_action``, ``smartquotes_excludes``
configuration variables.

- if ``smartquotes`` is set to False, then Smart Quotes transform is not
  applied even if a Docutils configuration file activates it,

- the current default of ``smartquotes_excludes`` deactivates Smart
  Quotes for Japanese language, and also for the ``man`` and ``text``
  builders.

  However, currently ``make text html`` deactivates Smart Quotes for
  ``html`` too, and ``make html text`` activates them for ``text`` too,
  because the picked environment is shared and already transformed.

- now Smart Quotes get applied also when source documents are in
  Markdown or other formats.
 2018-01-05 15:06:10 +01:00
Takeshi KOMIYA
f1f6ca8cc9 Merge branch 'happy_new_year' into master 2018-01-01 01:09:17 +09:00
Takeshi KOMIYA
2426cedb8b A happy new year! 2018-01-01 01:06:58 +09:00
Takeshi KOMIYA
0998bd5330
Merge pull request #4355 from stephenfin/remove-epub3-references 
templates: Remove 'epub3' targets
 2017-12-29 10:30:55 +09:00
Stephen Finucane
9f7f5f2a44 doc: Add missing sphinx-apidocs opt, envvar 
Add docs for '--module-first' option and 'SPHINX_APIDOC_OPTIONS'
environment variable. Per the closest thing we have to official man page
guidelines [1]:

  ENVIRONMENT

  lists all environment variables that affect the program or function
  and how they affect it.

[1] https://linux.die.net/man/7/man-pages

Signed-off-by: Stephen Finucane <stephen@that.guru>
Fixes #2250
 2017-12-28 23:00:53 +00:00
Stephen Finucane
f048d668e5 doc: Remove invalid note for epub3 builder 
This doesn't appear to be true any more, based on the code.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-12-28 21:28:55 +00:00
Takeshi KOMIYA
b094c401de docs: make explicitly :meth: reference (refs: #4344) 2017-12-27 14:59:59 +09:00
Jean-François B
f5dfdfcfe2
Merge pull request #4332 from jfbu/latex_math_numfig 
Let LaTeX obey :confval:`math_numfig` for equation numbering
 2017-12-21 19:32:10 +01:00
jfbu
8cbd66f822 Trim docs about math_numfig 2017-12-21 18:47:35 +01:00
Takeshi KOMIYA
ffa9d48d0e
Merge branch 'master' into ignore__all__ 2017-12-22 00:28:26 +09:00
jfbu
3bb61e9094 Let LaTeX obey :confval:math_numfig for equation numbering 2017-12-21 12:23:20 +01:00
jfbu
7ea4fa535a Make LaTeX obey numfig_secnum_depth for figures, tables, code-blocks 
Notes:

- also fixes #4314

- although numbering of figures, tables and code-blocks will be same as
  in html, due to issue #4318 the numbering of enclosing sectioning units
  themselves may go deeper in html than PDF via latex. But this commit
  makes sure numbering goes to minimal depth needed by numfig_secnum_depth
 2017-12-20 23:27:39 +01:00
jfbu
0a66d51cbc Merge branch 'stable' 2017-12-20 21:52:45 +01:00
Kevin Keating
e932ff5ad2 Closes #947: autodoc now supports ignore-module-all to ignore a module's __all__ 2017-12-20 15:07:33 -05:00
Takeshi KOMIYA
e2bf2ef11d
Merge pull request #4166 from jahn/math_numfig 
Number equations across pages and by section (fix #3991, #4080)
 2017-12-21 00:39:44 +09:00
Takeshi KOMIYA
7054c0306a doc: Remove mentions to deprecated options (both are removed at 8c2fabe v1.3) 2017-12-20 10:43:13 +09:00
Takeshi KOMIYA
b4a1bddeaa
Merge pull request #4313 from tk0miya/update_math_doc 
Fix doc: now eq role works whole of project
 2017-12-20 00:26:53 +09:00
Takeshi KOMIYA
242bf9a38a Fix typo 2017-12-20 00:11:28 +09:00
Takeshi KOMIYA
04995b703f Fix typo 2017-12-20 00:05:57 +09:00
Oliver Jahn
9a39295291 add version 2017-12-18 06:41:50 -05:00
jfbu
72bffcf0f4 Add precision to docs of latex_toplevel_sectioning 2017-12-18 11:20:07 +01:00
jfbu
fcbabcd9b5 Merge branch 'stable' 
Conflicts:
	sphinx/apidoc.py
	sphinx/application.py
	sphinx/quickstart.py

	modified:   CHANGES
	modified:   doc/config.rst
	modified:   doc/markup/inline.rst
	modified:   sphinx/application.py
	modified:   sphinx/builders/__init__.py
	modified:   sphinx/cmd/quickstart.py
	modified:   sphinx/ext/apidoc.py
 2017-12-18 10:13:49 +01:00
Oliver Jahn
56d4e0c80d make math_numfig default to True 2017-12-17 14:02:32 -05:00
Oliver Jahn
27285dfeed use :rst:role: markup 2017-12-17 13:56:06 -05:00
jfbu
46b1896228 Again rewording docs about numfig_secnum_depth 2017-12-17 17:56:03 +01:00
Takeshi KOMIYA
41f9cb200a Fix doc: now eq role works whole of project 2017-12-17 23:44:28 +09:00
Takeshi KOMIYA
8bb6a01210 Fix mark up 2017-12-17 02:21:10 +09:00
Takeshi KOMIYA
299b11f26f Replace AutodocReporter by switch_source_input() 2017-12-17 02:13:11 +09:00
Oliver Jahn
44708b03dc
Merge branch 'master' into math_numfig 2017-12-16 11:15:07 -05:00
Oliver Jahn
04f2929f59 mention limitation to html-like targets 2017-12-16 10:37:02 -05:00
jfbu
ba1368072f Typo place holder --> placeholder 2017-12-16 11:51:00 +01:00
jfbu
a9602e4597 Improve numref docs 2017-12-16 11:46:33 +01:00
jfbu
f780f92d1b Mention `:numbered:` needed in numfig_secnum_depth docs 2017-12-16 11:32:40 +01:00
jfbu
070fbb97e5 Add markup and clarify numfig_secnum_depth docs 2017-12-16 11:05:33 +01:00
Takeshi KOMIYA
d003707f71 Merge branch 'stable' 2017-12-16 14:54:58 +09:00
jfbu
b131c33af5 Fix markup in doc/ext/math.rst 2017-12-15 22:54:52 +01:00
jfbu
7e75d46ea1 Again docs of `-M latexpdf`! 2017-12-14 12:54:29 +01:00
jfbu
a1b04e05d7 Remove docs of `-M latexpdfja` sphinx-build option 
Indeed, if latex_engine is not appropriately set, the ``make latexpdf``
then fails because the Makefile in latex build repertory is the one for
pdflatex, not platex+dvipdfmx.

Besides, if language is 'ja', then latexpdf automatically uses the
platex latex_engine, hence the platex/dvipdfmx pipeline, and latexpdfja
is not needed.

For now, only removing documentation.
 2017-12-14 12:47:11 +01:00
jfbu
e782ee6b63 Again docs of make latexpdf/latexpdfja 2017-12-14 12:42:17 +01:00
jfbu
fdd87e504c Docs of make latexpdfja 2017-12-14 12:03:42 +01:00
jfbu
4ca7bfc601 Merge branch 'stable' 2017-12-12 11:00:52 +01:00
jfbu
faadbef757 Expose some sphinx.sty LaTeX internals for customizability (refs: #4285) 2017-12-12 10:57:49 +01:00
jfbu
43e6f1aa96 Fix VerbatimHighlightColor key declared non-sphinx-prefixed colour name 2017-12-11 23:09:19 +01:00
jfbu
ad4481eb15 Merge branch 'stable' 2017-12-11 22:54:34 +01:00
jfbu
3bbfbadce5 Add a note for future maintenance by TeX hackers 2017-12-10 16:51:10 +01:00
jfbu
c220ae3ecb Update docs relative to emphasize-lines 2017-12-10 16:20:00 +01:00
jfbu
70f8d4ddfc Support `:emphasize-lines:` in PDF output (closes #1238) 2017-12-10 12:37:36 +01:00
Jakob Lykke Andersen
466241d43a C++, small cleanup after PR #4189 2017-11-25 14:37:27 +01:00
Jakob Lykke Andersen
697248aec7 Merge branch 'cxx2a-concepts' of git://github.com/mickk-on-cpp/sphinx into mickk-on-cpp-cxx2a-concepts 2017-11-20 22:31:37 +01:00
Takeshi KOMIYA
4abe6cb62e Fix #4221: napoleon depends on autodoc, but users need to load it manually 2017-11-11 21:53:20 +09:00
Matthew Woodcraft
6b15c9c1c7 #3998: Add optional section numbering in plain text output 
Controlled by new config values: text_add_secnumbers and
text_secnumber_suffix.
 2017-11-05 22:51:38 +00:00
Takeshi KOMIYA
f46c91b652 Merge branch 'stable' 2017-11-02 00:49:10 +09:00
Takeshi KOMIYA
79df05b36d Revert "Add :confval:smart_quotes to disable smart quotes through `conf.py` (refs: #4142)" 
This reverts commit bfd39c12b2.
 2017-11-01 22:43:40 +09:00
jfbu
9701c236d4 Trim docs/config.rst now that new config setting smart_quotes exists 2017-10-31 20:31:56 +01:00
jfbu
4b3d41c855 Fix typo in doc/config.rst 2017-10-31 20:30:32 +01:00
Takeshi KOMIYA
9ac68edced
Merge pull request #4178 from tk0miya/deprecate_string_for_html_sidebars 
a single string value for ``html_sidebars`` will be deprecated in 2.0
 2017-10-31 10:37:04 +09:00
Takeshi KOMIYA
83c266aa2e using a string value for `html_sidebars` will be removed in 2.0 2017-10-30 13:41:57 +09:00
Takeshi KOMIYA
bfd39c12b2 Add :confval:smart_quotes to disable smart quotes through `conf.py` (refs: #4142) 2017-10-27 00:45:06 +09:00
lucdanton
9aac2420d3 C++: remove function concepts. 2017-10-26 08:15:09 +02:00
Takeshi KOMIYA
47049ce5f6 Merge branch 'master' into improve_theme_sidebars 2017-10-25 23:53:44 +09:00
Takeshi KOMIYA
7e7b389eed Merge branch 'stable' 2017-10-23 12:23:58 +09:00
jfbu
6b4a0123fa Fix the fix of #4090 (sorry) 2017-10-22 13:28:46 +02:00
jfbu
5e86c1c934 Fix #4090: extra LaTeX macros via `latex_additional_files` 2017-10-22 13:24:03 +02:00
jfbu
90e3425ed7 Fix #4149: Documentation: Help choosing latex_engine 2017-10-22 11:45:28 +02:00
Takeshi KOMIYA
b78f3090a0 HTML themes can set up default sidebars through `theme.conf` 2017-10-22 15:14:02 +09:00
Takayuki SHIMIZUKAWA
101b289351 Merge pull request #4097 from stephenfin/argparse-integration 
Fix #3259: Argparse integration
 2017-10-21 18:58:55 +09:00
Takeshi KOMIYA
134f3b1884 Merge branch 'stable' 2017-10-21 01:50:50 +09:00
jfbu
5dbfc43dda Make clearer that Sphinx applies Smart quotes by default 
modified:   doc/config.rst
 2017-10-19 10:00:08 +02:00
jfbu
6a897af1d9 Clarify docs about `html_use_smartypants` deprecation 2017-10-19 09:56:14 +02:00
jfbu
77c5aaaa97 Fix #4134: [doc] docutils.conf is not documented explicitly 2017-10-19 09:23:41 +02:00
Oliver Jahn
7fc43d3365 use numfig for numbering equations by section rather than page 2017-10-18 16:52:28 -04:00
Stephen Finucane
bdaab9ef1b Remove static scripts 
Executable scripts without the '.py' extension are already created and
installed by setuptools, by way of the 'console_scripts' section. These
scripts are unnecessary noise. If people want to test this behavior
locally, use a virtualenv.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-10-09 16:28:39 +01:00
Takeshi KOMIYA
1292089255 Close #1448: qthelp: Add new config value; qthelp_namespace 2017-10-08 23:22:56 +09:00
Takeshi KOMIYA
2839fc5f68 Update docs (refs: #1448) 2017-10-08 13:15:43 +09:00
Stephen Finucane
9d114577dc Fix typo in doc 
It's 'py:mod', not 'py:module'. I don't know why this wasn't caught by
Sphinx itself.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-10-05 09:42:37 +01:00
Julien Schueller
21ec11e1a7 Document qthelp configuration 2017-10-02 17:26:21 +02:00
Alex Gaynor
f9250e198b Switched stylesheet for font to HTTPS to avoid mixed content issues 2017-09-24 14:02:53 -04:00
Takeshi KOMIYA
3f1f5bb081 Merge pull request #3938 from TimKam/3751-document-m-option 
#3751 document -M command line option
 2017-09-25 00:09:25 +09:00
Takeshi KOMIYA
00169a07e6 Merge branch 'stable' 2017-09-24 22:51:23 +09:00
Takuya Noguchi
0e82661b63 #4068: Update linkcheck docs to use requests 2017-09-18 23:57:08 +09:00
Jakob Lykke Andersen
c43c781a03 Docs, add missing `member` role for C domain 
Fixes sphinx-doc/sphinx#4038
 2017-09-07 21:26:36 +02:00
Antony Lee
cfa03b9771 Fix documented default values for setuptools integration. 
The defaults were obtained by reading the implementation in
`setup_command.py`, notably `_guess_source_dir` and `finalize_options`.
 2017-09-01 22:30:04 -07:00
Atlas
16cbf658a2 Update tutorial.rst 2017-08-23 11:56:35 +02:00
Timotheus Kampik
ec9f373bfa #3751 use double back ticks 2017-08-23 00:05:56 +02:00
Takeshi KOMIYA
8b76d5b064 Merge pull request #4012 from avalentino/docstring-inheritance 
Docstring inheritance
 2017-08-21 23:31:17 +09:00
Takeshi KOMIYA
05b621a79a Merge pull request #3961 from gaborbernat/master 
fixes #3959 alias/rename support for classes inside inheritence diagrams
 2017-08-20 00:41:50 +09:00
Antonio Valentino
620491fcd5 Retireve docstirng form base classes (Closes #3140) 2017-08-18 11:37:11 +02:00
Timotheus Kampik
22ea6d560b #3996 add note: replace hyphen with underscore if build options set in setup() command 2017-08-13 16:20:25 +02:00
Takeshi KOMIYA
86c2e246f4 Merge pull request #3984 from TimKam/3548-update-docs-sphinxdoc-theme 
#3548 clarify that Sphinx docs do not use sphinxdoc theme anymore
 2017-08-09 00:02:54 +09:00
Timotheus Kampik
bd1a83c1ec #3548 clarify that Sphinx docs do not use sphinxdoc theme anymore 2017-08-06 21:53:39 +02:00
Timotheus Kampik
83155ddf7f #3978 fix typo 2017-08-05 13:50:26 +02:00
Timotheus Kampik
6413833a4f #3751 work in feedback 2017-08-02 00:20:49 +02:00
Bernat Gabor
0c3f9851b3 fixes #3959 alias/rename support for classes inside inheritence diagrams 2017-07-31 18:21:05 +01:00
Takeshi KOMIYA
abaf1cbb6b Merge branch 'stable' 2017-07-29 16:01:47 +09:00
Jean-François B
8d32f03a86 Merge pull request #3872 from jfbu/literalblock_cappos 
Add latex key to configure literal blocks caption position in PDF output
 2017-07-23 22:46:39 +02:00
Tony Narlock
112e8fe5e0 Add label for c++ domain 
Currently it's [#id2](http://www.sphinx-doc.org/en/stable/domains.html#id2) on sphinx-doc documentation
 2017-07-18 03:52:02 -05:00
Takeshi KOMIYA
d65c5c4ed8 Merge branch 'master' into 3866_suppress_pydomain_ref_warning 2017-07-17 17:42:23 +09:00
Timotheus Kampik
68fe4b2d6f #3751 document -M command line option 2017-07-16 09:50:08 +02:00
Takeshi KOMIYA
246143dc3a Merge pull request #3931 from tk0miya/3926_autodoc_warningiserror 
Fix #3926: Add ``autodoc_warningiserror`` to suppress the behavior of ``-W`` option
 2017-07-16 14:06:38 +09:00
Timotheus Kampik
e8cfd0f3d4 #1685 remove non-existing attributes from custom directive doc 2017-07-15 21:49:35 +02:00
Takeshi KOMIYA
1869f4d674 Update docs (refs: #3923) 2017-07-16 01:48:09 +09:00
Takeshi KOMIYA
d59fdda8c9 Merge pull request #3905 from TimKam/1236-add-note-referencing-arbitrary-locations 
#1236 add note: omit underscore in internal ref
 2017-07-15 22:37:51 +09:00
Takeshi KOMIYA
bfd71cd77b Fix #3926: Add `autodoc_warningiserror to suppress the behavior of -W` option 2017-07-15 22:04:56 +09:00
Stephen Finucane
348bf2a421 doc: Remove 'Author' section from man pages 
Per the closest thing we have to official man page guidelines [1]:

  Use of an AUTHORS section is strongly discouraged. Generally, it is
  better not to clutter every page with a list of (over time potentially
  numerous) authors; if you write or significantly amend a page, add a
  copyright notice as a comment in the source file.

We already do a good job of tracking authors in the AUTHORS file, so we
can remove this.

[1] https://linux.die.net/man/7/man-pages

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 16:08:49 +01:00
Stephen Finucane
65a81e2056 doc: Add sphinx-autogen man page 
This wasn't documented in depth anywhere, so do just that.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 16:08:40 +01:00
Stephen Finucane
9b7525d47d doc: Remove 'invocation' document 
This contains no useful information at this point. Better to simply drop
it.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 16:08:33 +01:00
Stephen Finucane
12e190f35f doc: Update sphinx-build man page 
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 16:08:29 +01:00
Stephen Finucane
2cfa2bc673 doc: Update sphinx-quickstart man page 
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 16:07:36 +01:00
Stephen Finucane
c244a7c9a9 doc: Update sphinx-apidoc man page 
This man page wasn't making full use of Sphinx's own features. Update it
to do so, and remove the duplicated information from 'invocation'.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2017-07-11 15:59:32 +01:00
Timotheus Kampik
328e57949e #1236 add note: omit underscore in internal ref 2017-07-02 15:19:47 +02:00
Takeshi KOMIYA
662d8deaf7 Merge pull request #3904 from TimKam/2307-fix-markup-glitch-lineno-start-doc 
#2307 add `::` to show markup sample, not evaluate it
 2017-07-02 21:54:31 +09:00
Takeshi KOMIYA
007593fa81 Merge branch 'stable' 2017-07-02 20:28:50 +09:00
Timotheus Kampik
16a2367301 #2307 add :: to show markup sample, not evaluate it 2017-07-02 13:24:38 +02:00
Yoshiki Shibukawa
f0766ce4cd fix #3840: epub_uid should be XML Name 2017-06-30 23:37:32 +09:00
Takeshi KOMIYA
7358081bd0 Merge branch 'master' into 3866_suppress_pydomain_ref_warning 2017-06-25 21:33:53 +09:00
Takeshi KOMIYA
e57fb74ee5 Merge branch 'stable' 2017-06-25 01:48:23 +09:00
jfbu
adc056200c Improve access to table and math markup info in docs 2017-06-20 15:57:32 +02:00
jfbu
6f283d6879 Update docs regarding the CDN used by default for MathJax 2017-06-20 00:20:22 +02:00
jfbu
521158549a Fix docs (Close: #3863) 2017-06-17 15:45:40 +02:00
jfbu
634d76faf1 latex: add option to put literal block captions before or after 
According to ``literalblockcappos`` setting in ``'sphinxsetup'``, (t)op
or (b)ottom, the caption will be typeset before or after the literal
block. If typeset above, its distance to frame is now identical to the
setting used for captions of tables (one half of the baseline).

Further keys ``verbatimcontinuedalign`` and ``verbatimcontinuesalign``
allow to horizontally align the continuation hints relative to the
literal block contents: either (l)eft, (c)enter, or (r)ight.
 2017-06-17 10:40:12 +02:00
jfbu
3d5e0c5d7c Merge branch 'stable' 2017-06-17 10:37:30 +02:00
Takeshi KOMIYA
db88166a3f Fix #3866: Suppress a new warning type: python refs 2017-06-17 11:34:43 +09:00
jfbu
c2277ae61c latex: hint that code-blocks continue on next page (closes #3764) 2017-06-14 09:49:39 +02:00
Takeshi KOMIYA
f6d0b07704 Merge branch 'stable' 2017-06-13 00:32:39 +09:00
Takeshi KOMIYA
9f1fca055f Merge pull request #3853 from brechtm/docs_rinohtype 
Docs: mention rinohtype as an alternative PDF builder
 2017-06-11 17:01:14 +09:00
Mr. Senko
9486f0d8f7 Add top-classes option to sphinx.ext.inheritance_diagram 
This will limit the scope of inheritance traversal
 2017-06-05 21:52:21 +03:00
jfbu
db8ff5fb75 Fix markup typo and missing bit in docs 2017-06-05 19:43:09 +02:00
jfbu
8b35c36cfe Shorten a definition list in latex docs 2017-06-05 16:55:37 +02:00
jfbu
5e2d4ca77b Merge branch 'stable' 2017-06-05 15:40:18 +02:00
jfbu
bd8c7e1410 Make the latex docs more concise 2017-06-05 15:34:23 +02:00
Brecht Machiels
4749157bd3 Docs: mention rinohtype as an alternative PDF builder 2017-06-05 14:51:35 +02:00
jfbu
d4f37925c0 Merge branch 'stable' 2017-06-03 17:36:19 +02:00
Sanjeev Gupta
a561fdb8c1 Expand and update list of extensions 
Updated from https://bitbucket.org/birkenfeld/sphinx-contrib/
 2017-06-02 04:11:48 +08:00
Sanjeev Gupta
a259df7dea Proof read and polish english. Some typos. 2017-06-02 00:22:33 +08:00
Sanjeev Gupta
97f2f16582 Proofread, polish some english, and convert to HTTPS 
All links checked, if HTTPS leads to the same page, then
convert.  A couple of typos as well.
 2017-06-01 22:50:16 +08:00
Sanjeev Gupta
cc69691032 Minor typo 2017-06-01 12:37:33 +08:00
Sanjeev Gupta
1a62b629c5 Test URLs and convert to HTTPS where possible 2017-05-31 22:07:01 +08:00
jfbu
075a8cfb8f Closes #3829: add `html_sidebars` default to sphinx-quickstart 2017-05-30 13:10:11 +02:00
Takeshi KOMIYA
b145011c1b Merge branch 'stable' 2017-05-29 00:33:13 +09:00
jfbu
8679e145e4 Update docs and CHANGES about Latexmk not being used on Windows 2017-05-28 16:24:21 +02:00
jfbu
d042b6d1cb Merge branch 'stable' 2017-05-28 10:02:39 +02:00
jfbu
350f58a618 Update CHANGES and docs regarding Latexmk dependency 2017-05-28 09:43:24 +02:00
Takeshi KOMIYA
ca6a1edd2f Merge branch 'stable' 2017-05-26 00:15:00 +09:00
jfbu
b18a3f82b4 Fix flake8 2017-05-20 10:16:24 +02:00
jfbu
6422f7b8c9 Fix #3742: missing `Index` bookmark and TOC entry in PDF builds at RTD 
The trick is to create an Index TOC/bookmarks entry in anticipation of
makeindex execution, as RTD (currently) does only one pdflatex run after
makeindex.

    https://github.com/rtfd/readthedocs.org/issues/2857

The workaround works for Sphinx own docs, which uses ``'manual'``
docclass and puts the general index at very end of document.
 2017-05-20 09:54:09 +02:00
Takeshi KOMIYA
4435d4fb26 Merge branch '1.6-release' 2017-05-15 00:20:09 +09:00
jfbu
ae1455077b Fix #3746: PDF builds fail with latexmk version 4.48 or earlier 
This is tested to work with latexmk version: 4.39 (10 Nov 2013).

For xelatex engine and with latexmk 4.52b or later (Jan 2017), setting
LATEXMKOPTS Makefile variable on command line to "-xelatex" results in
faster builds, because PDF is produced only on last run.
 2017-05-13 13:05:58 +02:00
Takeshi KOMIYA
78a20617b5 Merge branch '1.6-release' 2017-05-13 15:42:28 +09:00
jfbu
773659c41a Mention latex table templates in docs 2017-05-11 22:50:58 +02:00
jfbu
e277cb7285 Merge branch '1.6-release' 
Fixed conflicts:
	tests/test_build_html5.py

Also updated tests/test_build_latex.py
 2017-05-11 11:45:14 +02:00
jfbu
ad7d2bd548 Fix typo 2017-05-11 10:25:49 +02:00
jfbu
e20f28ce70 Improve latex docs of `latex_use_latex_multicolumn` config setting 2017-05-11 10:24:10 +02:00
jfbu
97625a2c5c Don't use forced mode for Latexmk 2017-05-08 20:53:03 +02:00
jfbu
f7876f6b74 Update latex docs 2017-05-07 11:12:18 +02:00
jfbu
a700f4631f Merge branch '1.6-release' 2017-05-07 11:11:02 +02:00
jfbu
38e6dfca34 Update latex docs 2017-05-07 11:10:41 +02:00
jfbu
5ca651f220 Merge branch '1.6-release' 2017-05-07 10:49:45 +02:00
Takeshi KOMIYA
af02bfa7b3 Merge branch 'master' into 3638_eqref_format 2017-05-07 16:20:51 +09:00
Takeshi KOMIYA
8f0d269069 Merge branch '1.6-release' into 3633_misdetect_unreferenced_citations 2017-05-07 16:14:50 +09:00
Takeshi KOMIYA
6d2bcf9c27 Mark as experimental 2017-05-07 16:13:19 +09:00
jfbu
f547e59a7a Merge branch '1.6-release' 2017-05-05 13:34:47 +02:00
jfbu
79412051d2 Merge branch 'stable' into 1.6-release 2017-05-05 13:33:50 +02:00
jfbu
321a5e7a5e Fix #3702: abstract LaTeX styling of figure legends into sphinxlegend 2017-05-04 09:59:29 +02:00
Jakob Lykke Andersen
d4d0ea68fe C++, update docs and changelog 2017-05-04 14:04:33 +09:00
jfbu
3cff7faf77 Merge branch '1.6-release' 2017-05-03 11:40:21 +02:00
jfbu
ca543eee23 Separate latexmk and pdflatex options for better control 2017-05-03 10:59:12 +02:00
Takeshi KOMIYA
b27fbc4aa5 Remove html_use_smartypants (deprecated) 2017-05-03 17:27:32 +09:00
Takeshi KOMIYA
354e360783 Merge pull request #3677 from tk0miya/remove_deprecated_features_in_1.7 
Remove deprecated features in 1.7
 2017-05-03 17:10:16 +09:00
jfbu
af76149a2b Fix style-check whitespace error in doc 2017-05-03 07:52:32 +02:00
jfbu
7bbc8c1f88 By default, `make latexpdf` will try to ignore LaTeX errors 
For example, if a graphics file is missing. The error is still reported
but some functional PDF may still have been produced. Some projects have
temporary errors with LaTeX (missing Unicode characters, graphics file
using wrong formats, ...) affecting some small percentage of the
documentation, and it may be important to make at least some PDF
available, postponing complete resolution of LaTeX problems to a later
date.
 2017-05-03 00:30:33 +02:00
Takeshi KOMIYA
72e635c775 Merge branch '1.6-release' 2017-04-29 23:51:29 +09:00
Takeshi KOMIYA
d1e8e41b5e Fix #3633: misdetect unreferenced citations 2017-04-29 23:22:00 +09:00
Takeshi KOMIYA
c7d90ab18c Update doc 2017-04-29 15:15:22 +09:00
Takeshi KOMIYA
721c3d5fae Merge branch 'stable' into 1.6-release 2017-04-29 15:11:55 +09:00
Takeshi KOMIYA
bd66ffc1fa Fix the unreleased version number is shown (refs: #3678, #3027) 2017-04-28 01:19:01 +09:00
Takeshi KOMIYA
361a34257b Remove deprecated feature: latex_keep_old_macro_names 2017-04-27 21:49:19 +09:00
Takeshi KOMIYA
f2c93b3175 Remove deprecated feature: epub2 builder 2017-04-27 21:49:19 +09:00
Takeshi KOMIYA
a252954ea3 Fix #3638: Allow to change a label of reference to equation 2017-04-27 21:47:20 +09:00
Takeshi KOMIYA
8462d4bcda doc: Update 2017-04-27 21:24:33 +09:00
Aaron Carlisle
458d1487b2 From Review: Fix typos 2017-04-26 12:59:49 -04:00
Aaron Carlisle
f92523751e Docs: Add seealso message to config page leading to api docs 
While hanging around IRC in both #sphinx-doc and #readthedocs
I have found that a lot of people do not know about these options
even though a lot of theme are pretty common. For example,
adding a simple theme overide, most people will edit layout.html
instead of Sphinx.add_stylesheet.
 2017-04-26 11:53:08 -04:00
Mark Hillebrand
a7c8795d07 doc/invocation.rst: document missing options for sphinx-apidoc 2017-04-26 16:17:11 +02:00
Dmitry Shachnev
9236beb9ee Deprecate the html_use_smartypants option 2017-04-25 14:17:30 +03:00
Takeshi KOMIYA
c50321d3ca Merge branch 'master' into drop_websupport 2017-04-23 19:18:01 +09:00
Takeshi KOMIYA
5da74f463b Merge pull request #3649 from tk0miya/deprecate_sphinx_theme_entry_point 
Fix #3628: Rename sphinx_themes entry point to sphinx.html_themes
 2017-04-23 16:40:02 +09:00
Takeshi KOMIYA
55818b7419 Update docs 2017-04-23 16:03:46 +09:00
Takeshi KOMIYA
ca618b2998 Update docs 2017-04-22 19:04:00 +09:00
Takeshi KOMIYA
621a4e6f61 Fix #3628: Rename sphinx_themes entry point to sphinx.html_themes 2017-04-22 14:59:10 +09:00
Takeshi KOMIYA
2b9b4f92a5 Add image_converter_args confval 2017-04-22 13:29:17 +09:00
Takeshi KOMIYA
c525723807 Add sphinx.ext.imgconverter 2017-04-22 13:29:16 +09:00
Takeshi KOMIYA
241c0db7bc Merge branch 'master' into support_remote_images 2017-04-22 09:45:05 +09:00
Yoshiki Shibukawa
fb48f5a921 Merge pull request #3505 from shibukawa/feature/refactoring_epub_builder 
Refactoring EPUB builders: split common codes from EPUB2 builder
 2017-04-21 00:25:16 +09:00
Takeshi KOMIYA
f21ce2f03f Fix markup 2017-04-20 02:02:27 +09:00
Yoshiki Shibukawa
7bbf749bd1 Refactoring EPUB builders: split common codes from EPUB2 builder 2017-04-20 00:48:00 +09:00
Takeshi KOMIYA
806dff0e94 Merge branch 'master' into support_remote_images 2017-04-19 21:45:24 +09:00
shimizukawa
de2cd652ab update CHANGES refs #2961 2017-04-19 16:28:56 +09:00
Takeshi KOMIYA
ebdec70dfc Support images in Data URI on non-HTML builders 2017-04-19 01:40:49 +09:00