Commit Graph

700 Commits

Author SHA1 Message Date
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
Timotheus Kampik
94b467dbc8 #4255 clarify documentation of `startdocname` parameters.
* Relative path from source directory

* Similar to ``master_doc`` in functionality
2018-07-01 16:10:51 +02:00
jfbu
90c2b528b1 Update docs and CHANGES for `latex_use_xindy` config variable 2018-06-30 23:37:26 +02:00
Takeshi KOMIYA
1140e81df7 Merge remote-tracking branch 'stephenfin/doc-rework' 2018-06-26 01:05:19 +09:00
Daniel Hahler
8f94429a21 doc: fix func/meth references to Sphinx 2018-06-25 08:25:56 +02: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
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
Jon Dufresne
2f17a0e8c8 Update Python 2 doc links to Python 3
Python 3 docs are more actively maintained and are the future.
2018-06-09 20:59:43 -07:00
Jakob Lykke Andersen
cc026946f7 C++, add support for anon entities.
Anonymous entities are specified with names starting with "@",
but are rendered as "[anonymous]".

Fixes sphinx-doc/sphinx#3593 and sphinx-doc/sphinx#2683.
2018-06-09 12:24:34 +02:00
Takeshi KOMIYA
fc7817b854
Merge pull request #5034 from tk0miya/add_html_js_files
Add :confval:`html_js_files`
2018-06-09 11:51:11 +09:00
Jean-François B
95a8099913
Merge branch 'master' into latex_remove_shorthandoff_variable 2018-06-08 19:53:46 +02:00
Takeshi KOMIYA
9fc2657d7e Add :confval:html_js_files 2018-06-09 02:38:36 +09:00
jfbu
359854fa78 Postpone to 3.0 removal of ExtBabel.get_shorthandoff() 2018-06-07 18:29:24 +02:00
jfbu
b41b1dac5c Deprecate sphinx.writers.latex.ExtBabel.get_shorthandoff()
This partially reverts d17f3955a5
2018-06-06 19:16:14 +02:00
Takeshi KOMIYA
e30b10a57d html: Output `canonical_url metadata if :confval:html_baseurl` set 2018-06-06 21:18:17 +09:00
jfbu
a32c358342 Remove usage of internal shorthandoff variable from LaTeX writer 2018-06-05 18:38:59 +02:00
Jakob Lykke Andersen
6d52b63eee C++, support for unions. 2018-05-26 20:03:25 +02:00
Jakob Lykke Andersen
f592483156 Add cpp:texpr role (style alternative to cpp:expr)
Simplified version of sphinx-doc/sphinx#4836,
thanks to mickk-on-cpp.
2018-05-26 17:25:41 +02:00
Daniel M. Capella
d2b0098045
doc: Fix minor typo "like" -> "link" 2018-05-13 04:15:11 +00:00
Takeshi KOMIYA
5a90e0bc85 Update docs (refs: #4875) 2018-05-03 17:40:32 +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
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
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
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
622119a9d4 Fix #789: `:samp:` role supports to escape curly braces with backslash 2018-04-28 12:56:01 +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
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
jfbu
525f3bd104 Typo from #4801 2018-04-01 11:39:58 +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
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
Tim Graham
725d20b0f9 Add section labels for intersphinx 2018-03-29 13:23:39 -04: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
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
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
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
jfbu
bde42595c6 Update installation docs 2018-03-17 22:56:53 +01: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
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