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,224 Commits 2 Branches 219 Tags 163 MiB
2760b3bb79
Commit Graph

55 Commits

Author SHA1 Message Date
Rafael Fontenelle
ca74c94610
doc: fix grammar of possessive of plural noun 2021-10-03 11:04:10 -03:00
usaturn
c56a37e4d5 fix link of code of conduct 2021-07-17 17:38:27 +09:00
Juan Luis Cano Rodríguez
5e7c011b92 Fix broken link to third-party extensions 2021-06-16 18:32:02 +02:00
Juan Luis Cano Rodríguez
70ee9bcd6a Tutorial link in front page, audience, objectives, and prerequisites 2021-05-26 21:25:38 +02:00
igo95862
6c5f77c689
doc: Upgrade pygments.org links to HTTPS 2021-05-16 15:53:58 +03:00
igo95862
e67c9e5df1
doc: Upgrade docutils.sourceforge.io links to HTTPS 
Also change any docutils.sourceforge.net link to io
top level domain.
 2021-05-16 15:53:49 +03: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
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
Tetsuo Koyama
f3aae09231
💝 Let's say thanks to all translator 2020-03-28 17:56:35 +09:00
Takeshi KOMIYA
7faeb793e2 Close #6658: Add CODE_OF_CONDUCT (#6661) 
* Close #6658: Add CODE_OF_CONDUCT

* #6658 refine CoC

* Base on Django CoC: https://www.djangoproject.com/conduct/
* Simplify: we are a smaller project and can be more concise
* Add to ToC
* Link from README
* Link from index page
 2019-10-06 16:41:37 +02:00
juh
6be9556904
adding German book about Sphinx 
Adding a link to the authors bookpage.
 2019-05-02 11:49:23 +02:00
Takeshi KOMIYA
0e8fb2dd25 doc: update download URL for PDF and EPUB 2018-06-17 16:55:18 +09: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
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
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
7aa43488ea add a paragraph about sphinx-contrib on the front page 2014-09-22 10:20:02 +02:00
Takayuki Shimizukawa
0cfb00db79 Add documentation to make contribution easier. 2014-08-31 00:02:01 +09: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
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
23d2d534df Non-dev Python docs are now Sphinx too. 2011-01-07 22:07:15 +01: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
fa00d30daf Add link to rst2pdf generated version. 2010-01-12 21:11:20 +00:00
Georg Brandl
598f2dda3a Add link to Japanese translation of the docs. 2009-11-08 19:36:16 +01:00
Georg Brandl
77c5026198 Add link to matplotlib's sampledoc, because I suck at writing tutorials. 2009-11-08 18:20:53 +01:00
Georg Brandl
aedbdd953d Fix more line length and trailing whitespace. 2009-01-10 22:18:18 +01:00
Georg Brandl
22cefe2114 Add quote to front page. 2008-11-16 18:44:54 +01:00
Georg Brandl
27ee1ed5d4 Reword index page a bit. 2008-11-06 10:35:55 +01:00
Georg Brandl
96caeae56d Update repo location. 2008-11-02 23:52:49 +01:00
Georg Brandl
83b2fdcf78 Add note how to find source examples. 2008-09-11 23:15:32 +00:00
Georg Brandl
4fb3723102 Merged revisions 64733,64743,64755,64795,64803 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64733 | georg.brandl | 2008-07-05 17:04:12 +0200 (Sat, 05 Jul 2008) | 2 lines

  Ask for common extensions in quickstart.
........
  r64743 | georg.brandl | 2008-07-05 18:34:55 +0200 (Sat, 05 Jul 2008) | 2 lines

  Add a direct link to the examples page.
........
  r64755 | georg.brandl | 2008-07-06 07:32:09 +0200 (Sun, 06 Jul 2008) | 2 lines

  Backport r64750.
........
  r64795 | georg.brandl | 2008-07-08 16:48:58 +0200 (Tue, 08 Jul 2008) | 2 lines

  Use correct filename extension in search.
........
  r64803 | georg.brandl | 2008-07-08 20:46:49 +0200 (Tue, 08 Jul 2008) | 2 lines

  Accept class options for modules too.
........
 2008-07-08 18:48:21 +00:00
Georg Brandl
17e7e61778 Merged revisions 64703-64708,64710-64712 via svnmerge from 
svn+ssh://pythondev@svn.python.org/doctools/branches/0.4.x

........
  r64703 | georg.brandl | 2008-07-04 19:24:00 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix linkcheck builder crash for malformed URLs.
........
  r64704 | georg.brandl | 2008-07-04 19:32:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Add 0.5 compatibility for more admonitions.
........
  r64705 | georg.brandl | 2008-07-04 19:38:37 +0200 (Fri, 04 Jul 2008) | 2 lines

  Remove silly "rubric" restriction in latex writer.
........
  r64706 | georg.brandl | 2008-07-04 19:41:44 +0200 (Fri, 04 Jul 2008) | 2 lines

  Document rubric:: Footnotes behavior.
........
  r64707 | georg.brandl | 2008-07-04 19:45:28 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix XHTML.
........
  r64708 | georg.brandl | 2008-07-04 19:50:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  More XHTML fixes.
........
  r64710 | georg.brandl | 2008-07-04 19:59:56 +0200 (Fri, 04 Jul 2008) | 2 lines

  Copy the html_logo to the output static dir.
........
  r64711 | georg.brandl | 2008-07-04 20:37:43 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix latex code for module names with underscores that have platforms.
........
  r64712 | georg.brandl | 2008-07-04 20:46:40 +0200 (Fri, 04 Jul 2008) | 2 lines

  Fix a crash with nonlocal image URIs.
........
 2008-07-04 18:49:39 +00:00