Commit Graph

86 Commits

Author SHA1 Message Date
Takeshi KOMIYA
f14d60dcd2
Merge pull request #5096 from tk0miya/update_docs
doc: update URL of PDF and EPUB
2018-06-21 01:29:42 +09:00
Takeshi KOMIYA
fd8e0be57a Merge branch '1.7' 2018-06-19 23:39:23 +09:00
Takeshi KOMIYA
0e8fb2dd25 doc: update download URL for PDF and EPUB 2018-06-17 16:55:18 +09:00
Takeshi KOMIYA
248869e2db doc: Use badge to show latest release 2018-06-17 16:45:58 +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
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
Danish Prakash
0fe14c3e3b
potential typo
`You can also download PDF/EPUB versions of the Sphinx documentation: a PDF version generated from the LaTeX Sphinx produces, and an EPUB version.`

Either a typo or maybe wrong sentence structure.
2018-02-06 11:09:48 +05:30
Kurt McKee
beefd445c1 Convert doc HTTP links to HTTPS, even in documentation examples
A small number of URL's redirected, or were stale but had obvious
alternatives. These have been updated. For example, a Google style
guide for Python was no longer available at googlecode.com, and
Paver docs are now at readthedocs.io.
2018-01-20 16:50:35 -06:00
Jon Dufresne
cc3abba171 Prefer https & readthedocs.io instead of readthedocs.org for links
Read the Docs moved hosting to readthedocs.io instead of
readthedocs.org. Fix all links in the project.

For additional details, see:

https://blog.readthedocs.com/securing-subdomains/

> Starting today, Read the Docs will start hosting projects from subdomains on
> the domain readthedocs.io, instead of on readthedocs.org. This change
> addresses some security concerns around site cookies while hosting user
> generated data on the same domain as our dashboard.
2018-01-07 09:10:27 -08:00
Tim Hoffmann
bbfcb2443d cleanup formatting of some sidebar items 2018-01-06 17:49:27 +01:00
Takeshi KOMIYA
bd66ffc1fa Fix the unreleased version number is shown (refs: #3678, #3027) 2017-04-28 01:19:01 +09:00
shimizukawa
732bb213ca add link to Changes in toppage 2016-12-15 21:53:13 +09:00
Yoshiki Shibukawa
1742d2ea02 fix inter document link 2016-09-02 16:37:29 +09:00
Yoshiki Shibukawa
792d154b1a fix sphinx document's style to satisfy xhtml standard 2016-09-01 23:54:54 +09:00
Yoshiki Shibukawa
0ef331a4c7 fix sphinx document's template not to have link to genindex for epub result 2016-08-23 08:02:54 +09:00
Takeshi KOMIYA
8a9459b308 Merge branch 'stable' 2016-08-09 23:19:11 +09:00
Yoshiki Shibukawa
90b3c79895 fix html entity to fix epub error 2016-08-09 16:58:56 +09:00
Eric Holscher
7acf202842 Clean up the prose on the main site page 2016-03-15 10:53:20 -07:00
Georg Brandl
5e8642983b Fixup links in the documentation. 2016-02-13 16:00:46 +01:00
shimizukawa
09b931745d Switch links for pdf version documentation to on ReadTheDocs. 2016-01-10 11:18:55 +09:00
shimizukawa
ff01b78412 Remove version specific installation procedure and link to stable/latest document page because sphinx site has been moved to ReadTheDocs so the information is obsoleted. 2016-01-10 11:18:44 +09:00
Robert Lehmann
f323b60641 Explicitly mention sphinx-users mailing list
This should now answer searches for "mailing list" and "sphinx-", in case users just skim the Web site.

I have checked this in a Web browser and it looks good IMO (box not overfull.)
2015-06-24 21:13:24 +09:00
shimizukawa
cdc4f5d8bb fix http/https 2015-02-28 01:10:03 +09:00
shimizukawa
720ef3dafe display pip install method for develop version 2015-02-25 16:25:50 +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
91887b0183 Merge branch 'stable' 2015-01-02 13:51:31 +01:00
Georg Brandl
a84e036622 development process updates: bb->gh, hg->git 2015-01-02 13:49:38 +01:00
Georg Brandl
7aa43488ea add a paragraph about sphinx-contrib on the front page 2014-09-22 10:20:02 +02:00
Georg Brandl
772dbbd4d9 Fix the docs index sidebar for unreleased versions. 2014-09-22 09:58:09 +02:00
Matt Hickford
580458fce1 Explain how to install Sphinx with pip (rather than easy_install). Fixes #1447 2014-09-14 17:13:52 +00:00
Takayuki Shimizukawa
0cfb00db79 Add documentation to make contribution easier. 2014-08-31 00:02:01 +09:00
Robert Lehmann
529519275e Fixed W3C Validator errors in index page. 2014-02-05 15:06:59 +01:00
Georg Brandl
9d25862700 add link to "write the docs", move hosting chapter to home page 2014-01-12 12:44:36 +01:00
Georg Brandl
de2e47bfce IRC channel update. 2013-09-16 09:16:08 +02:00
Georg Brandl
4b3a0b677d Add the cover of the Learning Sphinx book as an image. 2013-09-16 05:17:38 +02:00
Georg Brandl
900c50dd92 merge with stable 2013-09-16 05:10:27 +02:00
Georg Brandl
3541cef023 Update link to Japanese translation of the docs, and a link to the new OReilly book. 2013-09-16 05:09:05 +02:00
Takayuki Shimizukawa
2c409959ac Add i18n capabilities for custom templates.
For example: The Sphinx reference documentation in doc directory provides
sphinx.pot file from ``doc/_templates/*.html`` by ``make gettext``.
2013-03-10 22:07:31 +09:00
Dmitry Shachnev
1c5638e40c doc/_templates/index.html: fix link to the list of extensions 2013-02-10 16:39:44 +04:00
Georg Brandl
20279b07a4 New doc design "sphinx13". 2013-01-18 23:17:11 +01:00
Georg Brandl
0939d6fcdb New doc design "sphinx13". 2013-01-18 23:17:11 +01:00
Georg Brandl
4763419db1 Update Sphinx URL to new sphinx-doc.org domain. 2012-11-04 11:28:12 +01:00
Georg Brandl
d769d4ae71 Change sphinx-dev to sphinx-users where applicable. 2012-10-30 08:47:20 +01:00
Georg Brandl
23d2d534df Non-dev Python docs are now Sphinx too. 2011-01-07 22:07:15 +01:00
Georg Brandl
08047fc523 Add Pocoo logo to the sidebar on the index page. 2010-10-18 18:06:02 +02:00
Georg Brandl
13017eecc8 Go to #pocoo. 2010-07-28 14:53:39 +02:00
Georg Brandl
6bc1ce0527 #395: Update Japanese translation URL. 2010-05-22 14:21:01 +02:00
Georg Brandl
0ee675b7cf Update blurb in setup.py and on the index page, link directly to tutorial.rst from index. 2010-02-28 23:12:00 +01:00
Georg Brandl
5d40d8bd63 merge with trunk 2010-01-17 14:24:24 +01:00
Georg Brandl
27f85a8dab Fix style inconsistency. 2010-01-14 21:33:30 +01:00