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
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
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
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
