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
15,333 Commits 2 Branches 219 Tags 163 MiB
53c1dff91c
Commit Graph

93 Commits

Author SHA1 Message Date
Takeshi KOMIYA
ba86f4ea78 Merge branch '2.0' 2019-03-07 01:23:26 +09:00
Takeshi KOMIYA
10869289ef docs: JS domain does not support reset current module 2019-03-03 14:56:38 +09:00
Stephen Finucane
b1ebdcd3c6 doc: Add "recipe" tutorial 
This is based on a post from opensource.com [1] and demonstrates how one
can use indexes for cross-referencing and domains to group these indexes
along with domains and roles. The source code was taken from [2] after
getting the license changed [3].

[1] https://opensource.com/article/18/11/building-custom-workflows-sphinx
[2] https://github.com/ofosos/sphinxrecipes
[3] https://github.com/ofosos/sphinxrecipes/issues/1

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2019-02-09 17:58:30 +00:00
Takeshi KOMIYA
6ca669295c Close #1851: Allow to omit an argument for code-block directive 2019-02-04 01:50:44 +09:00
Takeshi KOMIYA
e0e3ba4d91 doc: Fix indentation 2019-02-04 01:31:30 +09:00
Frank Erens
9e6fe21c6a Add 'cpp:struct' directive and 'cpp:struct' role. 
They are cosmetic variants of the class directive/role.
 2019-01-20 12:29:20 +01:00
Jakob Lykke Andersen
4e6dacd81b C++, add some missing .. versionadded directives. 2019-01-20 12:28:57 +01:00
Jakob Lykke Andersen
d6b7aad138 C++, alias directive 
See sphinx-doc/sphinx#4981
 2019-01-12 12:57:45 +01:00
jfbu
32d57b8637 Merge branch '1.8' 
resolved Conflicts:
	doc/development/tutorials/todo.rst
	sphinx/locale/__init__.py
	sphinx/search/zh.py
 2018-12-28 12:50:20 +01:00
jfbu
1e07cb10fc Fix various spelling typos 2018-12-27 13:06:33 +01:00
jfbu
fdb6147555 LaTeX (doc): explain how to allow Unicode input in math 
Closes: #5249
 2018-12-20 19:43:50 +01:00
Takeshi KOMIYA
00254ea256
Merge pull request #5556 from drewrisinger/drewrisinger-typo-1 
[Bug]: Typo in Domains.rst
 2018-10-25 22:23:26 +09:00
Drew
dc35335a35
[bug]: Correct RST header 
Have correct amount of "~" for RST heading.
 2018-10-24 16:28:11 -04:00
Drew
3812d06544
Update domains.rst 2018-10-10 15:56:29 -04:00
Jakob Lykke Andersen
1c035d7203 C++, add support for overload-specific references. 
The "any" and "func" roles now accepts full function declarations.

Fixes #1552
 2018-08-18 08:27:23 +02:00
Jakob Lykke Andersen
4397606d03 C++, fix direct lookup problem 
Also clarify documentation regarding cross-references involving templates.

See also sphinx-doc/sphinx#2057
 2018-08-11 11:04:56 +02:00
Takeshi KOMIYA
8e56f86383 Add :rst:role:math:numref role to refer equations (Same as :rst:role:eq) 2018-08-02 01:52:40 +09:00
Takeshi KOMIYA
e045dacc84 doc: Move description for math confval, directives and roles to usage 2018-07-28 18:43:02 +09: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
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
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
Takeshi KOMIYA
0ea06e40ca
Merge branch 'master' into 789_escape_braces_on_samp_role 2018-05-03 01:32:35 +09: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
Tim Graham
725d20b0f9 Add section labels for intersphinx 2018-03-29 13:23:39 -04: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