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
9,209 Commits 2 Branches 219 Tags 163 MiB
c57cd9cb06
Commit Graph

1752 Commits

Author SHA1 Message Date
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