Commit Graph

22 Commits

Author SHA1 Message Date
Stephen Finucane
29da4f9444 doc: Add guide on setuptool/distutils integration
While this feature is somewhat documented in the API guide, there's
nothing about this option in the main user guide. Given the lack of
blogs and articles talking about this feature, along with the amount of
projects that are only using the same copy-paste '[build_sphinx]'
definition, I imagine this is an issue.

Make the feature a little more accessible by adding a section to the
main user guide that details (a) the fact the feature exists, (b) why
you'd want to use it, and (c) how you can use it.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2017-02-24 13:41:34 -05:00
jfbu
7d3bddd4e3 Convert text into links at bottom of tutorial.rst and top of config.rst 2016-06-09 15:34:59 +02:00
Takeshi KOMIYA
8ea92359ba Fix warnings in CHANGES and docs 2016-01-12 13:36:12 +09:00
shimizukawa
b0d40ea22c Closes #1735: Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation. 2015-02-23 04:20:35 +00:00
Georg Brandl
bf6f5acd2c add distribution possibility 2014-09-14 17:26:13 +00:00
Matt Hickford
f5567e03fa Add instructions how to install Sphinx to top of tutorial 2014-09-14 17:19:32 +00:00
EricFromCanada
4883e1eba2 more corrections for spelling and grammar 2014-06-19 12:14:47 -04:00
EricFromCanada
36313d98b1 corrected contractions 2014-06-18 12:52:32 -04:00
EricFromCanada
8981b9bd13 corrections for misspellings 2014-06-18 11:19:01 -04:00
Georg Brandl
b944c843f5 Add warnings that autodoc imports the modules. 2014-03-05 07:45:45 +01:00
Georg Brandl
bae7682bad merge with intersphinx tutorial section 2014-01-10 14:55:25 +01:00
Takayuki Shimizukawa
bcff26c6da update a Intersphinx tutorial section. refs #1325 2013-12-18 08:33:37 +09:00
Takayuki Shimizukawa
1367f6f9c6 Added a "Intersphinx" tutorial section. (:file:doc/tutorial.rst). Closes #1325 2013-12-17 23:54:30 +09:00
Georg Brandl
b8967b4ee8 tutorial: make "documentation collection" clearer 2013-01-14 00:01:18 +01:00
Georg Brandl
38ebe67c4e Closes #585: document sphinx-apidoc. 2011-10-07 12:47:58 +02:00
Robert Lehmann
b8873fe7b0 Fixes #354: Addressed PDF generation in the tutorial. 2011-10-06 14:52:54 +02:00
Georg Brandl
f4f3066581 Use the new rst domain in the sphinx docs. 2010-04-17 10:39:51 +02:00
Georg Brandl
1ea64352fe A bit more tutorial. 2010-03-14 19:46:54 +01:00
Georg Brandl
c219938a73 Write a bit more of the tutorial. 2010-03-09 19:32:59 +01:00
Georg Brandl
9334d1537c Add some domain documentation. 2010-03-01 14:22:14 +01:00
Georg Brandl
2cbe10086f Rename tutorial, add example for image substitution. 2010-02-28 23:03:16 +01:00
Georg Brandl
f36592e418 Begin the Great Refactoring of the docs.
* Move sphinx-build option description from intro to a new document.
* Move toctree information to a new document in markup/.
* Add a tutorial document placed after intro. Begin filling it in.
2010-02-28 22:00:22 +01:00