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,736 Commits 2 Branches 219 Tags 163 MiB
8224f6f44a
Commit Graph

79 Commits

Author SHA1 Message Date
Martin Liska
9ec829fb50 texinfo: simplify reference emission. 
The commit adds a new config value 'texinfo_emit_document_references'
that blocks the emission of inline references and make it better readable
with legacy stand-alone reader ``info``.

Before the change we emit:
Default option value for @ref{e,,-Wshift-overflow3}.

while with texinfo_emit_document_references == True:
Default option value for -Wshift-overflow3.

It addresses limitations mentioned in Sphinx' FAQ:
https://www.sphinx-doc.org/en/master/faq.html#texinfo-info
 2021-11-12 14:00:48 +01:00
Takeshi KOMIYA
e0500f7354 doc: Fix docslint misunderstanding scope of code-blocks 2021-06-06 13:24:06 +09: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
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
Takeshi KOMIYA
d47f38e22d Merge branch '2.0' 2019-12-21 12:21:49 +09:00
Jon Dufresne
e6915baae8 Remove redundant type="text/javascript" from <script> elements 
In HTML5, <script> elements default to MIME type text/javascript. The
HTML5 living standard and MDN recommend against including the attribute.

From https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#attr-type

> The HTML5 specification urges authors to omit the attribute rather
> than provide a redundant MIME type.

From https://html.spec.whatwg.org/#the-script-element

> Authors should omit the type attribute instead of redundantly setting
> it.
 2019-12-15 07:52:40 -08:00
Takeshi KOMIYA
1c152d249c Merge branch '2.0' 2019-07-07 18:50:58 +09:00
Takeshi KOMIYA
10883c2824 docs: Update FAQ for github pages 2019-07-07 16:08:54 +09:00
Takeshi KOMIYA
eb76799a89 doc: Fold lines by 80 columns 2019-05-29 10:43:59 +09:00
Takeshi KOMIYA
b9d7239d90 Merge branch '2.0' 2019-05-29 00:51:25 +09:00
Takeshi KOMIYA
9b2423c5bb doclinter: restrict by 90 columns 2019-05-26 10:53:53 +09:00
Takeshi KOMIYA
1e221da332 doc: Remove hieroglyph temporarily (refs: #6348) 2019-05-23 10:32:18 +09:00
SuryaGrandhi
1f77b95de6
Removing broken links 
Using sphinx with Read the Docs, the Getting Started link has been updated.
 2019-05-03 15:26:40 +05:30
Timotheus Kampik
a814a2c191 #36 work in review feedback 2019-02-26 14:59:02 +01:00
Timotheus Kampik
d5aa1c6ccc #36 add Google Search how-to to FAQ 2019-02-24 23:03:49 +01:00
ArtFlag
990b02b5fb Feedback 2018-12-19 17:35:17 +01:00
Arthur
adc1d2b59d
Merge branch 'master' into docs/extension-tutorials 2018-11-30 10:33:20 +01:00
ArtFlag
8479876798 Add a helloworld tutorial 2018-11-29 00:14:31 +01:00
ArtFlag
83e9e1378c Create a tutorial portal 2018-11-28 17:27:12 +01:00
Stephen Finucane
1c07f0004f doc: Add "theming" to usage guide 
This one is a little unusual. The current theming doc mixes user-focused
documentation with developer-focused documentation. This is confusing
and unnecessary. Resolve the issue by splitting the doc in two. The
user-focused docs are moved to the advanced section of the usage guide,
while the developer docs remain where they are, pending the addition of
a developer guide.

Signed-off-by: Stephen Finucane <stephen@that.guru>
 2018-11-16 15:23:33 +01:00
Jon Dufresne
dd383ec472 Prefer https:// links where available 2018-09-23 11:50:42 -07: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
Gussie Carther
390ea6d35a Fix #4420: Docs conflict on use of rst_prolog and rst_epilog 2018-04-14 17:51:06 +09:00
Takeshi KOMIYA
686de7dfff
Merge branch 'master' into drop_rst2pdf_support 2018-01-28 19:23:18 +09:00
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
Takeshi KOMIYA
a331e90c87 doc: Remove mentions to rst2pdf 2018-01-20 21:33:09 +09: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
Brecht Machiels
4749157bd3 Docs: mention rinohtype as an alternative PDF builder 2017-06-05 14:51:35 +02:00
Sanjeev Gupta
97f2f16582 Proofread, polish some english, and convert to HTTPS 
All links checked, if HTTPS leads to the same page, then
convert.  A couple of typos as well.
 2017-06-01 22:50:16 +08:00
Mike Fiedler
f7c0a8b702 Update faq epub link 
The epubcheck project was moved to GitHub.
 2016-12-11 09:01:02 -05:00
jfbu
c94f3b7d73 fix faq.rst (texinfo example with `info`) 2016-11-06 12:56:16 +01:00
Takeshi KOMIYA
6bbca6ba3c Merge branch 'stable' 2016-11-06 20:40:14 +09:00
Takeshi KOMIYA
4250052eda doc: Fix markup 2016-11-06 20:37:07 +09:00
Yoshiki Shibukawa
0248416c65 Fix document for Kindle and add description about kindlegen 2016-09-01 12:46:12 +09:00
Georg Brandl
d59f23b2c8 Fix highlight languages in docs. 2016-02-14 09:37:55 +01:00
Georg Brandl
5e8642983b Fixup links in the documentation. 2016-02-13 16:00:46 +01:00
EricFromCanada
65e924a3e4 rewrapping paragraphs when over 80 characters wide 2014-06-18 11:53:25 -04:00
Georg Brandl
9708319f5c docs: fix some broken links 2014-01-13 00:05:22 +01:00
Roland Meister
cc909ab2a9 More docs cleanup; add hint for the epub cover page 2013-06-07 20:48:14 +02:00
Jonathan Waltman
50d4aec15c [texinfo] Update CHANGES and relevant documentation. 2013-02-20 04:09:50 -06:00
Georg Brandl
2b06c656c1 faq: add sphinx-contrib 2013-01-14 00:07:19 +01:00
Georg Brandl
0701c850d2 faq: add Hieroglyph 2013-01-14 00:02:51 +01:00
Georg Brandl
9a4a3c9afa Satisfy "make check". 2011-10-09 23:09:57 +02:00
Eric Holscher
255433401f Added Read the Docs to the using documentation 2011-03-20 16:48:42 -07:00
Jonathan Waltman
883a7fd3cd Merge with https://bitbucket.org/birkenfeld/sphinx 2011-03-02 23:54:27 -06:00
Jonathan Waltman
23bb290c42 Document :confval:texinfo_domain_indices and update quickstart. 2011-02-23 17:55:39 -06:00
Daniel Neuhäuser
e46a8e9ded Change redirected URLs to the new locations 2011-02-05 21:48:54 +01:00
Jonathan Waltman
15c94d6947 Change example code to not use an actual control character. 2011-01-08 21:24:11 -06:00
Georg Brandl
6c23616b2c merge with 1.0 2011-01-08 20:09:29 +01:00
Georg Brandl
568c293226 Add link to sphinx-wiki. 2011-01-08 20:05:41 +01:00