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
18,245 Commits 2 Branches 219 Tags 163 MiB
dd2ff3e911
Commit Graph

3326 Commits

Author SHA1 Message Date
Takeshi KOMIYA
3059a999b2 Close #8326: Rename master_doc to root_doc 
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`.  The old name is still available.  But it is recommeneded
to use new one from now on.
 2021-02-28 17:10:57 +09:00
jfbu
ddef4950ee LaTeX: let bookmarks use high default depth 
Add bookmarksdepth key to latex_elements['sphinxsetup']
 2021-02-18 13:11:28 +01:00
jfbu
62401ef1ec Merge branch '3.x' 2021-02-12 21:27:17 +01:00
Jakob Lykke Andersen
a7fcc15683 C++, add noroot option to alias directive 2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen
06a956200b C, add noroot option to alias directive 2021-02-12 17:25:12 +01:00
Jakob Lykke Andersen
d0a4d0147e C++, add recursiveness to alias 
Fixes sphinx-doc/sphinx#8213 in the most basic way.
 2021-02-12 17:25:12 +01:00
Takeshi KOMIYA
61af7f48ad
Merge pull request #8873 from tk0miya/8860_bad_example 
Fix #8860: doc: Usage of recipe directive is wrong
 2021-02-13 01:04:27 +09:00
Takeshi KOMIYA
def6f13d8d Merge branch '3.x' 2021-02-13 01:01:30 +09:00
Takeshi KOMIYA
3b451bbcde
Merge pull request #8835 from tk0miya/refactor_linkcheck7 
refactor: linkcheck: Separate thread manager feature from builder class
 2021-02-12 23:32:30 +09:00
Takeshi KOMIYA
5c223d20d6 refactor: linkcheck: Separate thread manager feature from builder class 
To reduce the complexity of the linkcheck builder, this separates
the thread manager feature from the builder class as
HyperlinkAvailabilityChecker.
 2021-02-12 23:19:01 +09:00
Takeshi KOMIYA
d5de7bf3cf Fix #8860: doc: Usage of recipe directive is wrong 2021-02-12 20:51:53 +09:00
Takeshi KOMIYA
f17ab57b64 Fix #8860: doc: recipe directive crashes with AttributeError 
The pre check in the `ReceipeDirective.add_target_and_index() was wrong.
It checkes non-existing option "noindex", but it should check "contains"
option instead.
 2021-02-11 22:13:07 +09:00
jfbu
b9c53c8ca6 Merge branch '3.x' into merge_3.x_into_master 
Resolved Conflicts:
	sphinx/texinputs/sphinx.sty

Some hunks needed to go to sphinx/texinputs/sphinxlatexliterals.py,
others already belonged to split files.
 2021-02-09 19:03:38 +01:00
jfbu
87d0b15eab Also indent warning to not interrupt description list 2021-02-09 18:29:56 +01:00
jfbu
a310c4c5b6 Indent note directive inside list item 2021-02-09 18:25:37 +01:00
jfbu
32d8b4e445 Minor refactoring in doc/latex.rst 2021-02-09 18:11:24 +01:00
Jean-François B
1c08467040
Merge pull request #8851 from jfbu/latex_enhance_docs_about_index 
LaTeX: improve docs of 'printindex' and 'makeindex'
 2021-02-09 16:16:26 +01:00
Jean-François B
86ea2a93e0
Merge pull request #8854 from jfbu/latex_longstringsincodeblocks 
LaTeX: optionally apply a second forceful wrapping of long code lines
 2021-02-09 16:14:48 +01:00
jfbu
aaac721104 Typo 2021-02-09 16:04:01 +01:00
jfbu
035d13fd24 Update CHANGES and docs relative to new verbatimforcewraps 2021-02-09 15:47:15 +01:00
Takeshi KOMIYA
208f549b8a Merge branch '3.x' 2021-02-09 22:43:14 +09:00
jfbu
eee17ff61a Fix forgotten link to Pygments home site, mmmmpf 2021-02-09 12:33:16 +01:00
jfbu
abddafa98a Fix inexistent directive "notice", it is "note"... 2021-02-09 12:28:03 +01:00
jfbu
c6a8fb1625 Add verbatimmaxoverfull and verbatimmaxunderfull 2021-02-09 12:18:31 +01:00
jfbu
0076ad3fd3 Indicated force wrapping code lines is fragile with Unicode input 2021-02-09 00:01:39 +01:00
jfbu
702545da1c LaTeX: optionally apply a second forceful wrapping of long code lines 
Closes #8849
 2021-02-08 23:13:46 +01:00
jfbu
a984f5f7cc LaTeX: improve docs of 'printindex' and 'makeindex' 
Closes #8055
 2021-02-08 14:59:20 +01:00
Harrissou Sant-anna
08c2c23bb4
Make code block types more visible 2021-02-08 13:03:16 +01:00
Takeshi KOMIYA
4cbb2925fd Fix #8837: doc: Remove version info from html_title 2021-02-07 21:24:15 +09:00
Takeshi KOMIYA
84458da828 Merge branch '3.x' 2021-02-07 17:01:09 +09:00
Takeshi KOMIYA
899ccfd40e refactor: linkcheck: Deprecate attributes of linkcheck builders 
Move anchors_ignore, auth and to_ignore to
HyperlinkAvailabilityCheckWorker and become deprecated.
 2021-02-07 02:39:35 +09:00
Thibaud Colas
00e2c2e250
Fix broken "Extend" link in site header 
Spotted while navigating https://www.sphinx-doc.org/en/master/.
 2021-02-04 22:04:17 +00:00
jfbu
87fa272763 Merge branch '3.x' into merge_3.x_into_master 
Resolved Conflicts:
	sphinx/texinputs/sphinxpackagefootnote.sty
 2021-02-04 16:31:45 +01:00
jfbu
fbafb308b8 Merge branch '3.x' into master_with_merged_3.x 2021-02-02 18:01:55 +01:00
pbudzyns
270921d73a Merge remote-tracking branch 'upstream/3.x' into exclude-members-fix 2021-02-01 10:46:44 +01:00
pbudzyns
35adeeff41 update docs 2021-02-01 10:28:01 +01:00
Takeshi KOMIYA
804e46e27b
Merge pull request #8785 from tk0miya/8783_update_doc 
doc: Update doc for project_copyright (refs: #8783)
 2021-01-31 14:27:42 +09:00
jfbu
c07adc4ebb Fix docs markup from d6e11b89 
Sorry that I fixed this in master already, forgetting it was initially
merged into 3.x.
 2021-01-30 21:17:07 +01:00
jfbu
6dea091257 Fix markup in docs (from d6e11b89) 2021-01-30 21:14:02 +01:00
Takeshi KOMIYA
339ce2f894 Merge branch '3.x' 2021-01-30 11:49:08 +09:00
Takeshi KOMIYA
ffe8fbf271 doc: Update doc for project_copyright (refs: #8783) 2021-01-30 11:38:16 +09:00
jfbu
d6e11b89e9 Fix suppression of needed whiteline, encapsulate into \sphinxAtStartPar 
Define it to do nothing with lualatex engine
 2021-01-29 10:40:50 +01:00
jfbu
185a2d27fe Fix #8780: long words in narrow columns may not be hyphenated 
This is done by adding '\hskip0pt\relax\n' whenever a paragraph starts.
 2021-01-29 00:24:44 +01:00
jfbu
365ae80cc4 Revert alteration at c9480f994 merge of 3.x of doc/conf.py 
Compare doc/conf.py after merge at c9480f994 to what it was at 2ee033838.

It loses the modification from #8716 (merged at 38c614347) and thus
reverts doc/conf.py to former font config using mathpazo.
 2021-01-27 18:44:56 +01:00
jfbu
af2949c654 Merge branch 'master' into refactor_latex_into_multiple_files 2021-01-27 17:02:00 +01:00
Takeshi KOMIYA
c9480f9943 Merge branch '3.x' 2021-01-28 00:56:46 +09:00
jfbu
6e80d27841 Refactor LaTeX [1/2]: split sphinx.sty into separate components 
The latex macros from sphinx.sty were already partitioned into
successive sections.  The file sphinx.sty is split into multiple
files in concordance with this pre-existing sectioning.

The files are loaded via \input. File extension is .sty not .tex
to not confuse the Makefile.
 2021-01-27 15:58:48 +01:00
Takeshi KOMIYA
f22ef55af3
Merge pull request #8762 from tk0miya/refactor_doc2 
doc: Add hyperlinks to classifiers for sphinx extensions and themes
 2021-01-27 00:05:14 +09:00
Takeshi KOMIYA
84dc65ad51 html: html_codeblock_linenos_style defaults to 'inline' (refs: #7849) 
As discussed in #7879, the default style of line numbers for code
blocks in HTML output becames 'inline' by default.  And 'table' style
is now deprecated and will be removed in Sphinx-6.0.
 2021-01-26 01:42:17 +09:00
Takeshi KOMIYA
a3e83a80f0
Merge pull request #8746 from jfbu/latex_improve_our_pdfdocs 
Improve Sphinx own pdf docs
 2021-01-24 23:31:42 +09:00
Takeshi KOMIYA
34417831c5 doc: Add hyperlinks to classifiers for sphinx extensions and themes 2021-01-24 16:45:50 +09:00
Takeshi KOMIYA
0ad32905bf Merge branch '3.x' 2021-01-24 16:39:43 +09:00
Takeshi KOMIYA
51d500833e Merge branch '3.x' into 7774_remove_develop.rst 2021-01-24 16:34:47 +09:00
Takeshi KOMIYA
41ee2d6e65
Merge pull request #8738 from tk0miya/8118_today_fmt 
Fix #8118: doc: the default setting of today_fmt
 2021-01-24 14:42:20 +09:00
Takeshi KOMIYA
0e6a2a9ebd
Merge pull request #8737 from tk0miya/8510_html_logo_url 
Allow user to use url to reference html logo & favicon
 2021-01-24 14:40:56 +09:00
Takeshi KOMIYA
502c4ee5fb Merge branch '3.x' 2021-01-24 14:32:13 +09:00
Takeshi KOMIYA
15cbc6dbb0 Close #6550: html: Allow to use HTML permalink texts 
Add new configuration variables: `html_permalinks` and
`html_permalinks_icon`.

This refines the settings around HTML permalinks.

* html_add_permalinks
  * Deprecated.
* html_permalinks
  * Enable or disable permalinks feature.
* html_permalinks_icon
  * Change the icon for permalinks
 2021-01-24 14:17:07 +09:00
Takeshi KOMIYA
3a0a6556c5
Merge pull request #8741 from tk0miya/refactor_doc3 
doc: Show type annotations for methods of Sphinx application class
 2021-01-24 14:11:37 +09:00
jfbu
3a3a479f1e Improve Sphinx own pdf docs 
Prior to this the depth of the bookmarks is too low, one does not even
get to see for example what are the built-in extensions offered by
Sphinx.

Similarly the LaTeX created table of contents has not enough depth.
Dozens of contiguous pages from our documentation get only a single
link, it is very hard for newcomer to get some feeling of the scope of
Sphinx.  With a more detailed table of contents (be it inside the PDF or
via the collapsable bookmark panel of PDF viewer) learning Sphinx is
easier.
 2021-01-24 00:41:59 +01:00
Takeshi KOMIYA
2626a74f0a doc: Show type annotations for methods of Sphinx application class 2021-01-24 00:08:04 +09:00
Takeshi KOMIYA
3100ceb220 doc: minor fix 2021-01-23 22:32:17 +09:00
Takeshi KOMIYA
f707cb30a1
Merge pull request #7798 from stefanodavid/code-block-crossref-doc 
documentation for proper code-block cross-referencing
 2021-01-23 22:31:02 +09:00
Takeshi KOMIYA
41924776c4 Fix #8118: doc: the default setting of today_fmt 
Sphinx has used `'%b %d, %Y'` as a default setting of today_fmt longer.
So this fixes our document as Sphinx does.
 2021-01-23 22:11:33 +09:00
Takeshi KOMIYA
7cfcd81b76 doc: html_favicon and html_logo accept URL now 2021-01-23 20:49:15 +09:00
Takeshi KOMIYA
76d0a0be82 Update CHANGES 2021-01-23 20:45:03 +09:00
Takeshi KOMIYA
ccf4ae3729 Merge branch 'master' into 8510_html_logo_url 2021-01-23 20:44:13 +09:00
Takeshi KOMIYA
65a69965a1 html theme: Add favicon_url and logo_url 
To embed the external favicon and logo image, this adds new template
variable `favicon_url` and `logo_url` that point the external URL or
relative path for the favicon/logo file from current file.  It helps to
use it on template files.
 2021-01-23 20:39:09 +09:00
Steve Piercy
cef669cb0f Update the link to the new sphinx-contrib organization 
This should be backported to at least 3.x, too.
 2021-01-23 17:28:35 +09:00
Takeshi KOMIYA
37fc43a4d3
Merge pull request #8734 from stevepiercy/patch-2 
Update the link to the new sphinx-contrib organization
 2021-01-23 17:27:04 +09:00
jfbu
2e22bd0a23 Merge branch 'master' into latex_font_for_pdflatex 2021-01-23 09:13:08 +01:00
Steve Piercy
bd63ae9950
Update the link to the new sphinx-contrib organization 
This should be backported to at least 3.x, too.
 2021-01-23 00:08:57 -08:00
Takeshi KOMIYA
af0dfa20d0
Merge pull request #8247 from silene/inter_prodlist_refs 
Allow production lists to refer to tokens from other production groups.
 2021-01-23 17:07:52 +09:00
Takeshi KOMIYA
9a905ce547
Merge pull request #8724 from jfbu/latex_fancyboxissue 
Closes: #8339
 2021-01-23 16:47:21 +09:00
Takeshi KOMIYA
5ce72f465b Merge branch '3.x' 2021-01-22 22:52:32 +09:00
Takeshi KOMIYA
4dd4ff8736
Merge pull request #8726 from markus-oehme-pg40/patch-1 
doc: Link to detailed extension documentation
 2021-01-22 22:02:13 +09:00
Takeshi KOMIYA
5260143afe Fix #8704: viewcode: anchors are generated in incremental build 
The anchors for viewcode was generated in the reading phase only if
supported builder is used.  It causes anchors are missing on the
incremental build after the build for non supported builder.

This introduces `viewcode_anchor` node to insert the anchor even if non
supported builders.  They will be converted to the anchor tag in the
resolving phase for supported builders.  Or, they will be removed for
non supported builders.
 2021-01-22 21:41:42 +09:00
markus-oehme-pg40
e59365923b
doc: Link to detailed extension documentation 
I missed that there are actually two sections explaining extensions in the docs and just saw the examples based one. This lead to me thinking "kind of lousy documentation, but that's probably par for the course". Would there have been a pointer to the detailed extension API description it would have saved me hours of guesswork.
 2021-01-22 09:29:19 +01:00
jfbu
11e7feb6fa Closes: #8339 
Handled as only a documentation issue.
 2021-01-21 19:51:59 +01:00
François Freitag
aa5e4e2da0 Deprecate linkcheck builder {broken,good,redirected} 
These attributes were used to cache checked links and avoid issuing
another web request to the same URI.

Since 82ef497a8c, links are pre-processed
to ensure uniqueness. This caching the results of checked links is no
longer useful.
 2021-01-21 17:06:51 +01:00
jfbu
99a8b7f37f LaTeX: update default font configuration 
This replaces times package with tgtermes and tgheros (clones of Times and
Helvetica with better LaTeX support) and the monospace font from txfonts
package (txtt). This font is better matched with Times-like fonts than
Courier clones.

The changes applies to pdflatex/platex/uplatex.

Fixes: #8711
 2021-01-20 23:03:08 +01:00
jfbu
59694da63a Fix some mark-up issues in latex.rst with "Default:" lines 2021-01-20 21:15:52 +01:00
Guillaume Melquiond
8a1d0d0da6 Allow production lists to refer to tokens from other production groups. 
Outside production lists, syntax "`foo:bar`" already makes it possible to
refer to the production "bar" of group "foo". This commit offers the same
feature inside production lists. Similarly to the reference syntax,
prefixing with a tilde prevents the group from being displayed.

This commit also makes it possible to use "`:bar`" to refer to production
"bar" from a production list without a group name. This is especially
useful when one has a main (unnamed) grammar and one or several named
extensions that need to refer to it.
 2021-01-20 17:57:52 +01:00
Takeshi KOMIYA
82ef497a8c
Merge pull request #8702 from tk0miya/4304_linkcheck_same_url 
linkcheck: Do not check the availability of the same URL repeatedly
 2021-01-20 21:12:22 +09:00
Takeshi KOMIYA
cead0f6ddf linkcheck: Fix race condition that could lead to checking the availability of the same URL twice 
So far, linkcheck scans all of references and images from documents, and
checks them parallel.  As a result, some URL would be checked twice (or
more) by race condition.

This collects the URL via post-transforms, and removes duplicated URLs
before checking availability.

refs: #4303
 2021-01-20 20:58:27 +09:00
Takeshi KOMIYA
d49f3a1c78 refactor: autosummary: Deprecate _simple_info() and _simple_warn() 2021-01-20 02:23:34 +09:00
Takeshi KOMIYA
ca0677086d
Merge pull request #8658 from SolidifiedRay/feature-custom-section 
Close #8573: napoleon: Add more custom section styles
 2021-01-19 21:13:13 +09:00
SolidifiedRay
7ad85cd1e0 Close #8573: napoleon: Add more custom section styles 2021-01-18 11:43:40 -08:00
Takeshi KOMIYA
4cae0ecf86
Merge pull request #8690 from tk0miya/4550_align_default 
Fix #4550: The align attribute of figure nodes becomes None by default
 2021-01-18 02:14:27 +09:00
Takeshi KOMIYA
30f8640bab Merge branch '3.x' 2021-01-16 21:51:46 +09:00
Takeshi KOMIYA
3248bef3cc Fix #4550: The align attribute of figure nodes becomes None by default 
To keep compatibility with the standard doctree model of docutils,
this stops to use 'default' value as a default value of the align
attribute for figure and table nodes.
 2021-01-16 21:19:38 +09:00
Takeshi KOMIYA
b742bde8e6
Merge pull request #8684 from tk0miya/2030_automatic_dedent 
Fix #2030: automatic dedent support in code-block directive
 2021-01-14 01:11:02 +09:00
Takeshi KOMIYA
f81310708b
Merge pull request #8678 from tk0miya/doc_html_baseurl 
Fix #8677: doc: Update description of html_baseurl
 2021-01-14 01:10:12 +09:00
Takeshi KOMIYA
fddc42847f Fix #2030: automatic dedent support in code-block directive 2021-01-13 01:10:28 +09:00
Takeshi KOMIYA
dffb565eea refactor: Deprecate DocumenterBrdige.reporter 
The logging system of Sphinx was migrated to sphinx.util.logging now.
So it's time to deprecate reporter interface for Documenters.
 2021-01-12 01:48:16 +09:00
Takeshi KOMIYA
32ac5f2e57 Close #207: Now highlight_language supports multiple languages 
This changes the structure of `highlight_options` to a dictionary that
maps language names to option dictionary.  It allows to setting pygments
options for multiple languages at once.
 2021-01-11 21:40:09 +09:00
Takeshi KOMIYA
5d07135a1e Fix #8677: doc: Update description of html_baseurl 2021-01-11 19:45:55 +09:00
Takeshi KOMIYA
f433581b04 doc: Fix highlight language 2021-01-10 22:22:30 +09:00
Takeshi KOMIYA
5460ea103b Merge branch '3.x' 2021-01-08 01:23:17 +09:00
Takeshi KOMIYA
af4e615a8a Close #6241: html: Allow to add JS/CSS files to the specific page 
Allow to add JS/CSS files to the specific page when an extension calls
`app.add_js_file()` or `app.add_css_file()` on `html-page-context`
event.
 2021-01-07 02:12:07 +09:00
Takeshi KOMIYA
a9c7dd7037 Merge branch '3.x' 2021-01-03 00:20:27 +09:00
Takeshi KOMIYA
e9a4ebf70d doc: Add explanation for the priority attribute of html_*_files 2021-01-03 00:16:10 +09:00
Hong Xu
1f020196a7 DOC: modules are only available when recursive is on 
See
7ecf6b88aa/sphinx/ext/autosummary/generate.py (L314-L315)
 2021-01-01 11:12:58 -08:00
Takeshi KOMIYA
4b452338f9 Merge branch '3.x' 2021-01-01 13:57:19 +09:00
Takeshi KOMIYA
7ecf6b88aa Merge branch '3.4.x' into 3.x 2021-01-01 13:56:19 +09:00
Takeshi KOMIYA
f996859420 A happy new year! 
.. note::

   $ find sphinx tests LICENSE doc/conf.py -type f -exec sed -i '' -e 's/2007\-20../2007-2021/' {} \;
   $ git co sphinx/locale/**/*.js sphinx/templates/epub3/mimetype
 2021-01-01 13:40:48 +09:00
Takeshi KOMIYA
62a0ee3fef Merge branch '3.x' 2020-12-31 14:33:09 +09:00
Takeshi KOMIYA
21698c1446
Merge pull request #8614 from tk0miya/deprecate_AttributeDocumenter_isinstanceattribute 
refactor: Deprecate AttributeDocumenter.isinstanceattribute()
 2020-12-30 19:47:17 +09:00
Takeshi KOMIYA
c99412695d
Merge pull request #8292 from tk0miya/update_coding_style 
docs: Update coding style
 2020-12-30 01:44:03 +09:00
Takeshi KOMIYA
c0f923ee6c refactor: Deprecate AttributeDocumenter.isinstanceattribute() 2020-12-29 20:06:29 +09:00
Takeshi KOMIYA
a122397b4b Merge branch '3.x' 2020-12-29 18:37:45 +09:00
Takeshi KOMIYA
150f788e0e
Merge pull request #8600 from tk0miya/8132_project_copyright 
Close #8132: Add project_copyright confval as an alias of copyright
 2020-12-28 17:26:49 +09:00
Hong Xu
d9ca895dbb
Update autodoc.rst 2020-12-27 21:24:19 -08:00
Hong Xu
6927130ff1
Doc: Correct type: "TypeAlias" -> "AliasType" 2020-12-27 21:23:31 -08:00
Takeshi KOMIYA
c5a9d04d45
Merge branch '3.x' into 8132_project_copyright 2020-12-28 13:56:11 +09:00
Takeshi KOMIYA
b19bce971e
Merge pull request #8593 from tk0miya/8592_meta_public_doesnt_affect_to_variables 
Fix #8592: autodoc: `:meta public:` does not effect to variables
 2020-12-28 13:51:50 +09:00
Takeshi KOMIYA
ce52a90d92 Fix #8592: autodoc: :meta public: does not effect to variables 
To control the visibility of variables, ModuleDocumenter have to load
docstring of them on `get_object_members()` phase.  This reimplements
it and `get_module_members()` helper to fetch docstring on earlier
phase (as ClassDocumenter does).
 2020-12-27 22:21:34 +09:00
Takeshi KOMIYA
c7d1536828 Close #8132: Add project_copyright confval as an alias of copyright 
Avoid to pylint error, add a new config variable; project_copyright
as an alias of `copyright`.
 2020-12-27 18:40:06 +09:00
Takeshi KOMIYA
9e9e486e65 Close #8022: autodoc: Allow to hide the value of the variables via metadata 
autodata and autoattribute directives does not show right-hand value of
the variable if its docstring contains ``:meta hide-value:`` in
info-field-list.
 2020-12-27 12:46:03 +09:00
Takeshi KOMIYA
140ef33469 Fix #7875: doc: Add PythonDomain.note_object() 2020-12-26 21:12:15 +09:00
Faris A Chugthai
24566623e1
Update the sphinx core events in appappi.rst 
I'm very happy to see that the events in Sphinx have been laid out in order as they have been in this doc.

With that being said the notation I noticed was a bit odd. Some of the items in the list refer to events and as a result,
parenthesis are used to indicate the beginning and end of the parameters that the event takes.

In other items in the list, parenthesis are used for additional context for an event. The combination of some particularly very long lines,
the intermixing of comments, pseudo-code, indentation of items following a `for` or an `if` made this very difficult to read on a mobile device.

As a result, I've added whitespace, fixed a typo, reduced the length of some lines by moving them to a new line, and removed all `()` that were not
present to indicate parameters fed to a function.
 2020-12-21 22:45:35 -05:00
Takeshi KOMIYA
a7a77d154b Merge branch '3.x' 2020-12-20 21:33:57 +09:00
Takeshi KOMIYA
36e684bf83 refactor: Move _getmro() to sphinx.util.inspect module 2020-12-17 00:46:42 +09:00
Jon Dufresne
cb4f76fca2 Deprecate sphinx.util.osutil.movefile() in favor of os.replace() 
The utility function movefile() was added in
677d096393 to handle existing files on
Windows. Since Python 3.3, the stdlib function os.replace() fills this
role.
 2020-12-13 09:36:10 -08:00
Takeshi KOMIYA
2c98e909bf Merge branch '3.x' 2020-12-14 02:02:29 +09:00
Takeshi KOMIYA
0b074c9e48 Merge commit 'a82b06f2abb1226d82b18e3f85bdf19be7b9eb3f' 2020-12-14 01:58:23 +09:00
Takeshi KOMIYA
399210c807
Merge pull request #8533 from tk0miya/deprecate_no_docstring 
refactor: Deprecate `no_docstring` argument for Documenter.add_content()
 2020-12-14 01:32:42 +09:00
Ned Batchelder
bac6ab8d0c Describe the intersphinx mapping a bit more 2020-12-13 08:04:55 -05:00
Takeshi KOMIYA
3638a9e4d1 refactor: Deprecate no_docstring argument for Documenter.add_content() 
This deprecates `no_docstring` argument for Documenter.add_content().
After this change, please use Documenter.get_doc() to control (suppress)
the content of the python object.
 2020-12-13 02:11:53 +09:00
Takeshi KOMIYA
1d9eeedde3 Fix #8508: LaTeX: uplatex becomes a default setting of latex_engine for Japanese 
Since v2.3, Sphinx supports uplatex as an alternative of latex_engine for Japanese
docs (refs: #4186, #6841). uplatex is able to build a document without conversion
character encoding internally. It allows using unicode characters in documents.
Additionally, uplatex is compatible with platex (current default latex_engine for
Japanese docs).

This changes the default latex_engine for Japanese document to uplatex.
 2020-11-29 15:09:49 +09:00
Takeshi KOMIYA
bb63f03034 Fix #8503: autoattribute could not create document for a GenericAlias 2020-11-29 12:24:10 +09:00
Takeshi KOMIYA
da4c69c624
Merge pull request #8291 from QuentinSoubeyran/8285_napoleon_google_style_use_annotations 
Fix #8285: napoleon can use PEP526 annotations
 2020-11-28 18:11:30 +09:00
Takeshi KOMIYA
e6e23aa45b
Merge pull request #8488 from tk0miya/deprecate_InstanceAttributeDecorator 
refactor: Deprecate InstanceAttributeDocumenter
 2020-11-26 20:13:03 +09:00
François Freitag
6b90a63f08 Fix #6629: linkcheck: Handle rate-limiting 
Follow the Retry-After header if present, otherwise use an exponential
back-off.
 2020-11-25 17:34:55 +01:00
Takeshi KOMIYA
93c9ce5cd8 refactor: Deprecate InstanceAttributeDocumenter 
InstanceAttributeDocumenter is merged into AttributeDocumenter in #7946
and #8444. So it is no longer needed now.
 2020-11-26 01:22:25 +09:00
Quentin Soubeyran
ec30f77712 refactored code and tests, prepared for numpy feature 2020-11-25 08:45:25 +01:00
Quentin Soubeyran
f268665292 added napoleon_google_attr_annotations option to use PEP 526 on google style 2020-11-25 08:45:25 +01:00
Takeshi KOMIYA
ab844c3f27 Deprecate SlotsAttributeDocumenter 2020-11-24 19:36:14 +09:00
Takeshi KOMIYA
5ebacaec89
Merge branch '3.x' into 8460_TypeVar 2020-11-23 13:58:41 +09:00
Takeshi KOMIYA
64498ad0db
Merge pull request #8464 from tk0miya/deprecate_Documenter.get_object_members 
Deprecate Documenter.get_object_members()
 2020-11-23 13:24:20 +09:00
Takeshi KOMIYA
a00d62c445 Merge branch '3.x' 2020-11-22 16:04:07 +09:00
Takeshi KOMIYA
a57ce4047c refactor: Move _getannotations() to sphinx.util.inspect 2020-11-22 15:38:01 +09:00
Takeshi KOMIYA
9eb96d5c79 Fix #8460: autodata directive does not display the detail of TypeVars 
The details are only shown when automodule directive is used.  This
allows to document them via other auto* directives.
 2020-11-22 13:57:48 +09:00
Takeshi KOMIYA
8e29d57395 Rename ModuleAnalyzer.parse() to analyze() 
The word "analyze" is much appropriate for "ModuleAnalyzer" instead
of "parse".
 2020-11-22 02:59:29 +09:00
Takeshi KOMIYA
7e3ba5ddf6 Deprecate Documenter.get_object_members() 
At present, the implementation of Documenter.get_object_members() is
only for class objects.  In fact, no subclasses use it (all of them are
overriding the method).

This deprecates Documenter.get_object_members() and copies it to
ClassDocumenter.get_object_members().
 2020-11-21 15:42:46 +09:00
Takeshi KOMIYA
3a4ae2092a Merge branch '3.x' 2020-11-21 01:01:36 +09:00
Takeshi KOMIYA
f344fff55e Fix #8443: autodata directive does not support PEP-526 ivars 2020-11-20 22:38:58 +09:00
Takeshi KOMIYA
5676fdeb4e Rename :novalue: option to :no-value: option 
According to the existing options of autodoc directives, `:novalue:`
option is now renamed to `:no-value:` option.
 2020-11-15 14:20:30 +09:00
Marlon James
6082ce67a4 autodoc: document :novalue: option 2020-11-15 14:19:33 +09:00
Takeshi KOMIYA
78d407cf83 Update CHANGES for PR #8404 2020-11-14 18:55:25 +09:00
François Freitag
683635f5b4 linkcheck: Remove call to is_ssl_error() 
This method always returns False, it is dead code. The exception
checking stopped working because Requests library wraps SSL errors in a
`requests.exceptions.SSLError` and no longer throws an
`urllib3.exceptions.SSLError`. The first argument to that exception is
an `urllib3.exceptions.MaxRetryError`.
 2020-11-12 19:58:04 +01:00
Takeshi KOMIYA
279e547860 Merge branch '3.x' 2020-11-12 02:50:43 +09:00
François Freitag
0949735210
Sort imports with isort 
Keep imports alphabetically sorted and their order homogeneous across
Python source files.

The isort project has more feature and is more active than the
flake8-import-order plugin.

Most issues caught were simply import ordering from the same module.
Where imports were purposefully placed out of order, tag with
isort:skip.
 2020-11-11 13:19:05 +01:00
Takeshi KOMIYA
bbcd471557 Merge branch '3.x' 2020-11-09 02:50:08 +09:00
Takeshi KOMIYA
1955a08378
Merge branch '3.x' into 8105_incorrect_class_constructor 2020-11-08 12:34:09 +09:00
Takeshi KOMIYA
cad02e62e6 Fix #8375: URL of transifex project page 2020-11-05 23:52:59 +09:00
Takeshi KOMIYA
8bf84167a3 Merge branch '3.x' 2020-11-05 02:21:47 +09:00
Takeshi KOMIYA
6d05b1aeb3 Fix #8105: autodoc: the signature of decorated class is incorrect 
In #7651, autodoc stops to undecorate the functions on getting the
signature from the callables.  But some kinds of decorators conceals
the correct signature because they pass through their arguments via
`(*args, **kwargs)`.

This restarts to undecorate the functions again as before #7651.
 2020-11-05 01:57:40 +09:00
Takeshi KOMIYA
c028fb7a40
Merge pull request #8359 from sphinx-doc/8349_sphinx-contrib 
doc: Update sphinx-contrib repos' URL (refs: #8349)
 2020-11-03 11:29:31 +09:00
Takeshi KOMIYA
0e98e9b1a8 Fix #6914: Emit a detailed warning when failed to resolve :ref: 
To be clear the ambiguous warning for missing-reference :ref:,
this separates the warning to missing-label and missing-caption.

To emit a warning dynamically, this also adds a new event:
`warn-missing-reference` to customize warning messages via event
handlers.
 2020-11-03 02:27:43 +09:00
Takeshi KOMIYA
11edef1a26 doc: Update sphinx-contrib repos' URL (refs: #8349) 2020-11-03 02:13:05 +09:00
Takeshi KOMIYA
7eabbfc5ec
Merge pull request #8284 from tk0miya/7996_man_make_section_directory_by_default 
Close #7996: manpage: Make a section directory on build manpage by default
 2020-10-28 11:03:13 +09:00
Takeshi KOMIYA
c40b4249cd Merge branch '3.x' into master 2020-10-28 02:23:36 +09:00
Takeshi KOMIYA
a843fd3db8 Close #7996: manpage: Make a section directory on build manpage by default 2020-10-28 02:15:36 +09:00
Takeshi KOMIYA
b453be75c9 Fix #8298: sphinx-quickstart: Add :option:sphinx-quickstart --no-sep option 2020-10-26 01:12:36 +09:00
Takeshi KOMIYA
f26569007b
Merge pull request #8334 from mgeier/doc-favicon 
DOC: Add favicon
 2020-10-25 18:47:30 +09:00
Jon Dufresne
554bb5e9b9 Fix docs type: "the builder builders" → "builders" 2020-10-24 09:35:22 -07:00
Matthias Geier
84c6d693f4 DOC: Add favicon 2020-10-24 17:41:02 +02:00
Takeshi KOMIYA
3b85187ffa
Merge pull request #8289 from graingert/allow-to-suppress-duplicated-toc 
Allow to suppress "duplicated toc entry" warnings from epub builder
 2020-10-24 20:29:06 +09:00
Takeshi KOMIYA
f1af7dc84f
Merge pull request #8324 from pradyunsg/patch-1 
Documentation: Reword section on Third Party Themes
 2020-10-24 18:28:19 +09:00
Takeshi KOMIYA
445b9515c1 Merge branch '3.x' 2020-10-24 18:12:45 +09:00
Pradyun Gedam
18b2f2cdf2
Reword section on Third Party Themes 
- No longer attempt to be the location for listing themes -- only Sphinx-RTD-Theme was listed here.
- Mention the classifier used when searching on PyPI.
- Emphasize sphinx-themes.org as a gallery of themes.
 2020-10-21 11:16:59 +05:30
Thomas Grainger
3f26564c28
Apply suggestions from code review 2020-10-05 22:10:25 +01:00
Takeshi KOMIYA
8260d6b4fc docs: Update coding style 
Remove a reference to Pocoo Styleguide because it is removed now:
https://github.com/pallets/flask/pull/3554
 2020-10-05 22:16:59 +09:00
Thomas Grainger
3eecf133d8
Fix #8289: Allow to suppress "duplicated ToC entry found" warnings from epub builder 2020-10-05 09:29:16 +01:00
François Freitag
bd49c3c2ef
Outdated comment in docs config for intersphinx 
Intersphinx is in use since 6a396c7eb8.
 2020-10-05 08:34:26 +02:00
Takeshi KOMIYA
598b85da75 Merge branch '3.x' into master 2020-10-04 22:41:44 +09:00
Takeshi KOMIYA
38bb377464
Merge pull request #8273 from sphinx-doc/7996_man_make_section_directory 
Close #7996: manpage: Add man_make_section_directory
 2020-10-04 22:40:41 +09:00
Takeshi KOMIYA
2d37ba4419 autodoc: deprecate SingledispatchFunctionDocumenter 
In #7487, SingledispatchFunctionDocumenter is merged into
FunctionDocumenter.  SingledispatchMethodDocumenter is also.  As a result,
They are no longer needed.  So this deprecates them.
 2020-10-04 13:50:10 +09:00
Takeshi KOMIYA
178c05b059 Close #7996: manpage: Add man_make_section_directory 
Add a new config variable; man_make_section_directory to make a
section directory on build man page.  During 3.x, it defaults to
False and will be changed to True on 4.0 release.
 2020-10-03 22:30:20 +09:00
François Freitag
5166dd194c
Strip trailing whitespaces and normalize line endings 
Trailing whitespace do not have impact on the result, they are just
unused bytes. Most text editors are configured to strip trailing
whitespaces. Remove them all in one go.

Update a handful of files to use the UNIX line ending.
 2020-10-03 13:47:01 +02:00
Takeshi KOMIYA
f2c0dfe7c4 Close #6518: autodoc: Add autodoc_type_aliases 
autodoc_type_aliases allows to keep user defined type alises not
evaluated in the generated document.
 2020-10-03 16:03:35 +09:00
Takeshi KOMIYA
26ea870267 Merge branch '3.x' into master 2020-10-03 13:43:21 +09:00
Steve Piercy
81d7f2ee8a
Update link to sphinxcontrib on GitHub 2020-09-26 16:32:59 -07:00
Bradley Dice
a0116eaa58
Fix typo: anchestor -> ancestor. 2020-09-20 17:36:01 -05:00
Takeshi KOMIYA
5ef4825b57 Close #8081: latex: Allow to add LaTeX package until writing tex file 
This postpones the evaluation of LaTeX packages via
``app.add_latex_package()`` to just before writing .tex file.  That
allows extensions to add LaTeX packages during reading and resolving
phase.
 2020-09-21 01:01:49 +09:00
Tetsuo Koyama
9fe3fe4f6b
Add "Getting Started as a Translator" 2020-09-20 01:08:21 +09:00
Tetsuo Koyama
eef2f2a8b6
✏️ Fix grammer 2020-09-20 00:53:57 +09:00
Jakob Lykke Andersen
500f45fd4c C, recursive alias declarations 
Fixes sphinx-doc/sphinx#8141
 2020-09-13 16:37:53 +02:00
Takeshi KOMIYA
bec30596a8 Merge branch '3.x' into master 2020-09-13 10:54:21 +09:00
Patrick Decat
7a3170b77a Fix some broken links 2020-09-03 15:22:50 +02:00
Falko Axmann
849ef212bc Fixes minor typo in quickstart.rst 2020-08-30 14:39:20 +02:00
Takeshi KOMIYA
ae9f0dd299
Merge pull request #8140 from chrisjsewell/docs/execution-process 
📚 DOCS: Improve build process overview
 2020-08-22 00:21:26 +09:00
Chris Sewell
46177f6af3 Correct numbers 2020-08-21 01:58:28 +01:00
Chris Sewell
5c744d8342 📚 DOCS: Improve build process overview 2020-08-20 22:37:37 +01:00
Yves Chevallier
e45f55d32f Add rubric in Getting help 2020-08-15 13:34:57 +02:00
Takeshi KOMIYA
8412347f5d Merge branch '3.x' 2020-08-14 14:28:58 +09:00
Takeshi KOMIYA
dab15e2857
Merge pull request #8058 from nijel/single-domain 
i18n: Add support for having single text domain
 2020-08-14 14:21:43 +09:00
Adam J. Stewart
fa8ad979af sphinx.ext.autodoc: fix typo in docs 2020-08-11 11:05:00 -05:00
Takeshi KOMIYA
a8927bcd3e Merge branch '3.x' 2020-08-08 18:16:59 +09:00
Michal Čihař
1bf7fe424e i18n: Add support for having single text domain 
The gettext_compact can now be a string which is then a single domain
for all documents.

Fixes #784
 2020-08-07 20:22:30 +02:00
Matt from Documatt
db9375363c Add link to third party themes on GitLab 
GitLab, alternative to GitHub, also contains a lot of beautiful open source themes.
 2020-08-07 14:46:19 +02:00
Takeshi KOMIYA
f743be0054
Merge pull request #8047 from cjmayo/typos 
Assorted typos including sphinx-buid in internationalization figure
 2020-08-06 02:38:07 +09:00
Takeshi KOMIYA
059dc108ba Close #6698: doctest: Add :no-trim-doctest-flags: options 
To control trimming doctest flags manually, this adds new options
:trim-doctest-flags: and :no-trim-doctest-flags: to doctest
directives.  It helps to describes doctest module itself in python
doc (see #6698).
 2020-08-05 23:39:05 +09:00
Chris Mayo
9bac86a2fc Fix typo sphinx-buid in internationalization figure 2020-08-03 19:30:38 +01:00
Chris Mayo
fe4a158caf Fix typos in the documentation 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
46f0b3063d refactor: autodoc: Add EMPTY that matches to no members 
Add a special class `_Empty` to make the comparison of
:exclude-members: option simply.  It never matches to any members.
 2020-08-03 01:59:53 +09:00
Takeshi KOMIYA
57af828882
Merge pull request #8035 from tk0miya/8034_argument_for_private-members 
Close #8034: autodoc: :private-member: can take an list of member names
 2020-08-03 01:57:13 +09:00
Takeshi KOMIYA
af15593c0c Close #7768: i18n: figure_language_filename supports {docpath} token 
To build structured i18n imaging directory, figure_language_filename
now supports `{docpath}` token that is a dirname of the current
document.
 2020-08-02 16:28:54 +09:00
Takeshi KOMIYA
d7a84e83cc Close #8034: autodoc: :private-member: can take an list of member names 
Now :private-member: option can take an explicit list of member names to
be documented as its arguments (like :special-members: does).
 2020-08-02 01:27:14 +09:00
Takeshi KOMIYA
9969239b22 Merge branch '3.x' 2020-08-01 18:08:23 +09:00
Takeshi KOMIYA
c14c00397e Merge branch '3.x' 2020-08-01 16:59:00 +09:00
Takeshi KOMIYA
f71b26ac56
Merge branch '3.x' into 7993_texinfo_for_nested_desc 2020-08-01 15:50:55 +09:00
Ebram Shehata
df2d4839c4
Update basics.rst 2020-07-29 15:14:29 +02:00
Chris Holdgraf
b8ee3ac9a4 moving extension dev overview 2020-07-29 10:38:18 +01:00
Chris Holdgraf
84f7dffd99 comments 2020-07-29 10:38:18 +01:00
Chris Holdgraf
c7085162d1 rearranging a few docs and small updates 2020-07-29 10:38:18 +01:00
Chris Holdgraf
924befa07e Update doc/development/tutorials/builders.rst 2020-07-29 10:38:18 +01:00
Chris Holdgraf
729dcd0e03 flake8 2020-07-29 10:38:18 +01:00
Chris Holdgraf
60b105d6aa several documentation improvements to theming, templating, and extension development 2020-07-29 10:38:18 +01:00
Takeshi KOMIYA
e98f39d21d Fix #7993: texinfo: TypeError is raised for nested object descriptions 
The texinfo writer remembers the current desc node to render
a desc_annotation node.  This makes the mechanism robust to support
nested object descriptions.
 2020-07-25 22:57:12 +09:00
Takeshi KOMIYA
3336dcc2ae
Merge pull request #7997 from sphinx-doc/fix/6863 
fix 6863: add description literalinclude option (start/end have same string)
 2020-07-25 22:53:48 +09:00
Yoshiki Shibukawa
70aa913bb2 fix 6863: add description literalinclude option (start/end have same string) 2020-07-25 22:36:06 +09:00
Takeshi KOMIYA
778e297577 Update CHANGES for PR #7690 2020-07-25 21:45:13 +09:00
Takeshi KOMIYA
ac0a800265
Merge pull request #7690 from keewis/transform_numpy_parameter_types 
preprocessing numpy types
 2020-07-25 21:41:32 +09:00
Keewis
6ae1c601b9 add a section about napoleon_type_aliases to the documentation 2020-07-25 11:49:58 +02:00
Keewis
530793d997 update the link to the official docstring guide 2020-07-25 11:37:32 +02:00
Hameer Abbasi
a4413810bc Merge branch 'mathjax-3' of github.com:hameerabbasi/sphinx into mathjax-3 2020-07-24 17:01:39 +02:00
Hameer Abbasi
8f5ce152a1 Fold line. 2020-07-24 16:59:40 +02:00
Hameer Abbasi
98d3ed01ff Merge branch 'master' into mathjax-3 2020-07-24 16:58:55 +02:00
Takeshi KOMIYA
327c187284 Merge branch '3.x' 2020-07-24 23:49:45 +09:00
Hameer Abbasi
496ac3fe8b
Change MathJax 2 path string. 
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
 2020-07-24 12:31:23 +02:00
Hameer Abbasi
746cf3505c Merge branch 'master' into mathjax-3 2020-07-24 11:53:27 +02:00
Hameer Abbasi
aed8f719ca Expand warning and refer to it from CHANGES. 2020-07-24 11:52:30 +02:00
Takeshi KOMIYA
da174138af
Merge pull request #7927 from jnothman/name-case-clash 
Add autosummary_filename_map config to avoid clashes
 2020-07-24 01:07:19 +09:00
Takeshi KOMIYA
897be0ebae Close #7784: i18n: The alt text for image is translated by default 
Make alt text for image translatable by default without settings of
gettext_additional_targets.
 2020-07-19 12:58:28 +09:00
Hameer Abbasi
72f3592796
Delete repeated word. 
Co-authored-by: Dmitry Shachnev <mitya57@users.noreply.github.com>
 2020-07-15 14:39:56 +02:00
Hameer Abbasi
436519743b Move to MathJax 3. 2020-07-15 13:09:08 +02:00
Jakob Lykke Andersen
18b00d8cff Add docs and CHANGES for C changes 2020-07-14 11:48:58 +02:00
Johannes Lade
91285f39a6
Update description of autosummary_generate_overwrite 
The old description was confusing. Maybe it's just me not being a native speaker, but I think it was wrongly worded.
 2020-07-13 14:03:06 +02:00
Takeshi KOMIYA
e31fce0766 Close #7902: html theme: Add a new option globaltoc_maxdepth 2020-07-11 23:11:59 +09:00
Takeshi KOMIYA
70d521ad9c Merge branch '3.x' 2020-07-11 21:59:58 +09:00
Takeshi KOMIYA
6dfbc5108e Close #7849: html: Add html_codeblock_linenos_style 2020-07-11 20:59:38 +09:00
Takeshi KOMIYA
f3811a1c36 doc: Remove broken PDF image 
It was added unexpectedly in #7924.
 2020-07-11 00:28:22 +09:00
Takeshi KOMIYA
98a854deca
Merge pull request #7924 from tk0miya/7921_translation.png 
doc: Add translation.png to build latexpdf successfully
 2020-07-10 02:44:11 +09:00
Joel Nothman
72ca2bdffc Add autosummary_filename_map config to avoid clashes 2020-07-08 16:51:57 +10:00
Takeshi KOMIYA
d2fdc851fa doc: Add translation.png to build latexpdf successfully 2020-07-07 22:19:21 +09:00
Julien Palard
418576ddd1 Doc: Add missing 'env-merge-info' to the todo tutorial. 2020-07-06 17:55:55 +02:00
Takeshi KOMIYA
1a223209f2 Merge branch '3.x' 2020-07-05 19:56:21 +09:00
Jakob Lykke Andersen
09e057edf2
Merge pull request #7906 from jakobandersen/noindexentry 
Add :noindexentry: option
 2020-07-05 09:25:18 +02:00
Takeshi KOMIYA
fe444f70d8
Merge pull request #7911 from tk0miya/7907_update_docs 
doc: Update docs (refs: #7907)
 2020-07-05 12:22:19 +09:00
Jakob Lykke Andersen
c668500a4b Add :noindexentry: option 
Fixes sphinx-doc/sphinx#7052
 2020-07-04 19:34:00 +02:00
Takeshi KOMIYA
814efa55c4
Merge pull request #7897 from JulienPalard/typo 
FIX: Typo in tutorial/todo.
 2020-07-05 01:33:54 +09:00
Takeshi KOMIYA
ec3754bd94 Merge branch '3.x' 2020-07-05 01:32:54 +09:00
Takeshi KOMIYA
44f4b2ad97 Merge tag 'v3.1.0' 2020-07-05 00:10:47 +09:00
Takeshi KOMIYA
0c24baaa0c doc: Update docs (refs: #7907) 2020-07-04 11:56:45 +09:00
Takeshi KOMIYA
f27dfe337e
Merge pull request #7907 from tmetzl/patch-1 
doc: Clarify language specific figures format in docs
 2020-07-04 11:48:28 +09:00
Tim Metzler
5ba5cb60e3
Use double backticks for filename example 2020-07-03 19:08:53 +02:00
Tim Metzler
3982d526b2
Shorten line to less than 85 characters 2020-07-03 14:27:14 +02:00
Tim Metzler
9dcd88709c
Clarify language specific figures format 
I recently used sphinx for multilanguage documentation and found the explanation of the language specific figure format misleading. 
I replaced the underscores by periods and added a small example.
 2020-07-03 14:11:53 +02:00
Chris Holdgraf
ef03bcc6ea output files comment 2020-07-02 13:46:44 -07:00
Chris Holdgraf
853060a646 events 2020-07-02 13:42:53 -07:00
Jakob Lykke Andersen
8c82ecbf2c
Merge pull request #7895 from jakobandersen/c_cpp_noindex 
C, C++: remove noindex option
 2020-07-02 15:38:45 +02:00
Julien Palard
527a0361f1 FIX: Typo in tutorial/todo. 2020-06-30 17:13:19 +02:00
Jakob Lykke Andersen
ff5eb7cc2b C, C++: remove noindex option 
The option did nothing.
Improve error messages on duplicates.
 2020-06-30 13:52:18 +02:00
Jakob Lykke Andersen
7cbf54c210 C, add c:alias directive 2020-06-30 11:20:17 +02:00
Nguyễn Gia Phong
1a865069db napoleon: Add aliases Warn and Raise 2020-06-29 22:19:54 +07:00
Takeshi KOMIYA
42f29b6acf doc: Add modname separator tip for autodoc (refs: #7841) 2020-06-21 23:28:03 +09:00
Stefano David
f4cb82cd84 documentation for proper code-block cross-referencing 2020-06-07 18:06:51 +02:00
Takeshi KOMIYA
2fb5232b12 Fix typo 2020-06-06 01:21:35 +09:00
Takeshi KOMIYA
07d19ebe02
Merge pull request #7760 from Cielquan/feature/coverage_print_missing_as_warning 
coverage ext - config to log missing coverage
 2020-06-06 01:13:41 +09:00
Christian Riedel
f33eb15b83
documented coverage_show_missing_items confval 2020-06-05 17:42:26 +02:00
Takeshi KOMIYA
dce45413e6
Merge pull request #7762 from tk0miya/7247_linkcheck_request_headers 
Close #7247: linkcheck: Add linkcheck_request_headers
 2020-06-05 01:17:31 +09:00
Stephen Finucane
375fb52fe4 docs: Add information about Sphinx trove classifiers 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-03 22:45:11 +01:00
Takeshi KOMIYA
068b9b5738 Merge branch '3.x' 2020-06-04 00:18:30 +09:00
Stephen Finucane
f40bbee221 docs: Remove the 'develop' guide 
This contained a list of extensions, along with general contributing
information and pointers on how to develop your own extensions. The list
of extensions was very old, referenced the dead BitBucket repo and was
really not very helpful, while the contributing and development
information was just pointers to other, better documentation. Remove the
document wholesale and update any pointers we have to it to other,
better docs.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 22:02:19 +01:00
Stephen Finucane
e0d3e0aa8c docs: Update reference to sphinx-contrib organization 
This is now well established on GitHub and the Bitbucket organization is
no longer maintained. Update the documentation to indicate this.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 21:58:05 +01:00
Stephen Finucane
227bbf6559 docs: Expand organization document 
Provide some guidance on how one can become a core developer and explain
the different types of contribution one can make.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:13:31 +01:00
Stephen Finucane
fa5fadc3f3 docs: Tweaks to code of conduct 
- Replace unicode quotes with ascii, since Sphinx will automatically
  translate these for us
- Move the header to the root document
- Use an admonition instead of a header for the attribution section

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:10:24 +01:00
Stephen Finucane
6b480c97b2 docs: Rework contributing document, re-add CONTRIBUTING 
Reorder this to flow a little better and re-add the CONTRIBUTING
document, which now simply points to the main documentation.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:10:21 +01:00
Stephen Finucane
d3021f644f docs: Add contributing document 
This completes the migration from the CONTRIBUTING document to the new
in-tree contributing guide. The CONTRIBUTING document itself is
temporarily removed so that git will correctly mark the document as
having been moved. A future change will re-add this document as well as
rework the new contributing document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 12:08:34 +01:00
Stephen Finucane
a33483f154 docs: Add release process document 
This is based on content extracted from the CONTRIBUTING document.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 11:43:44 +01:00
Stephen Finucane
6b19678253 docs: Add organization overview 
Provide an introduction to how the Sphinx team is organized. This will
be expanded upon in a future change.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 11:43:44 +01:00
Stephen Finucane
6a5921d7b2 docs: Add "project internals" guide 
This is modelled off Django's guide of the same name [1]. In summary,
this will contain most of the information previously found in the
CONTRIBUTING document. For now, we move just the code of conduct and
authors documents.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-06-02 11:43:44 +01:00
Takeshi KOMIYA
a7725ad8ca Close #7247: linkcheck: Add linkcheck_request_headers 2020-06-01 01:48:46 +09:00
Takeshi KOMIYA
34f3579330
Merge pull request #7748 from tk0miya/2106_autodoc_docstring_signature_for_overloads 
Close #2106: autodoc: Support multiple signatures on docstring
 2020-05-31 14:48:41 +09:00
Takeshi KOMIYA
212fd67b9f
Merge pull request #7755 from stephenfin/doc/docutils-vs-sphinx 
[doc] Compare docutils and Sphinx
 2020-05-31 12:21:16 +09:00
Takeshi KOMIYA
59e0746cb5 doc: Remove intro.rst (ref: #7751) 2020-05-31 12:06:45 +09:00
Takeshi KOMIYA
350f5b3600
Merge pull request #7751 from stephenfin/doc/intro-section 
[doc] Remove the intro guide in favour of the quickstart guide
 2020-05-31 01:12:35 +09:00
Takeshi KOMIYA
6be72c6ed2
Merge pull request #7752 from stephenfin/doc/latex-rework 
[doc] Rework "latex" document
 2020-05-31 01:09:23 +09:00
Stephen Finucane
f3360e6922 docs: Fix typo, replace field lists with paragraphs 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:43:05 +01:00
Stephen Finucane
aaf2dafd63 docs: Compare docutils with Sphinx 
Add an FAQ entry comparing the two.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:38:12 +01:00
Stephen Finucane
e4e5c509b6 doc: Rework "templating" documents 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:29:13 +01:00
Stephen Finucane
97d1b323b7 docs: Merge intro and quickstart guide 
The intro guide mostly contained out-of-date information or information
that was duplicated from elsewhere. Remove it in favour of an enhanced
quickstart guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:25:45 +01:00
Stephen Finucane
f07ad49c22 docs: Add usage, development index page 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:24:40 +01:00
Stephen Finucane
52bb0b02bb docs: Fix a typo and some indentation 
Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:23:36 +01:00
Stephen Finucane
ceb72f9cd7 doc: Rework "latex" document 
Remove some unnecessary indentation, consistently document option
defaults, and fix some wrapping and whitespace.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2020-05-30 15:23:36 +01:00
Takeshi KOMIYA
800dcf0f0a Close #2106: autodoc: Support multiple signatures on docstring 2020-05-30 15:40:21 +09:00
Kai Welke
0ee57a6f6e
Fixed broken link to pygments lexers doc 2020-05-26 09:35:47 +02:00
Michaël Defferrard
5e5bd748e6
remove repeted word in reStructuredText Primer 2020-05-20 22:30:58 +02:00
Takeshi KOMIYA
752d3285d2 Update docs (refs: #7469) 2020-05-21 00:56:32 +09:00