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

Proofread, polish some english, and convert to HTTPS

Browse Source 
All links checked, if HTTPS leads to the same page, then
convert.  A couple of typos as well.
This commit is contained in:
Sanjeev Gupta 2017-06-01 22:50:16 +08:00
parent cc69691032
commit 97f2f16582
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/faq.rst
View File

@ -140,7 +140,7 @@ The following list gives some hints for the creation of epub files:
are often cut at the right margin. The default Courier font (or variant) is are often cut at the right margin. The default Courier font (or variant) is
quite wide and you can only display up to 60 characters on a line. If you quite wide and you can only display up to 60 characters on a line. If you
replace it with a narrower font, you can get more characters on a line. You replace it with a narrower font, you can get more characters on a line. You
may even use `FontForge <http://fontforge.github.io/>`_ and create may even use `FontForge <https://fontforge.github.io/>`_ and create
narrow variants of some free font. In my case I get up to 70 characters on a narrow variants of some free font. In my case I get up to 70 characters on a
line. line.
@ -148,7 +148,7 @@ The following list gives some hints for the creation of epub files:
* Test the created epubs. You can use several alternatives. The ones I am aware * Test the created epubs. You can use several alternatives. The ones I am aware
of are Epubcheck_, Calibre_, FBreader_ (although it does not render the CSS), of are Epubcheck_, Calibre_, FBreader_ (although it does not render the CSS),
and Bookworm_. For bookworm you can download the source from and Bookworm_. For Bookworm, you can download the source from
https://code.google.com/archive/p/threepress and run your own local server. https://code.google.com/archive/p/threepress and run your own local server.
* Large floating divs are not displayed properly. * Large floating divs are not displayed properly.
@ -176,7 +176,7 @@ The following list gives some hints for the creation of epub files:
$ make epub $ make epub
$ kindlegen _build/epub/yourdoc.epub $ kindlegen _build/epub/yourdoc.epub
kindlegen commands doesn't accept documents that have section The kindlegen command doesn't accept documents that have section
titles surrounding ``toctree`` directive: titles surrounding ``toctree`` directive:
.. code-block:: rst .. code-block:: rst
@ -191,18 +191,18 @@ The following list gives some hints for the creation of epub files:
Section After Toc Tree Section After Toc Tree
====================== ======================
kindlegen assumes all documents order in line, but resulting document kindlegen assumes all documents order in line, but the resulting document
has complecated order for kindlegen:: has complicated order for kindlegen::
``parent.xhtml`` -> ``child.xhtml`` -> ``parent.xhtml`` ``parent.xhtml`` -> ``child.xhtml`` -> ``parent.xhtml``
If you got the following error, fix document structure:: If you get the following error, fix your document structure::
Error(prcgen):E24011: TOC section scope is not included in the parent chapter:(title) Error(prcgen):E24011: TOC section scope is not included in the parent chapter:(title)
Error(prcgen):E24001: The table of content could not be built. Error(prcgen):E24001: The table of content could not be built.
.. _Epubcheck: https://github.com/IDPF/epubcheck .. _Epubcheck: https://github.com/IDPF/epubcheck
.. _Calibre: http://calibre-ebook.com/ .. _Calibre: https://calibre-ebook.com/
.. _FBreader: https://fbreader.org/ .. _FBreader: https://fbreader.org/
.. _Bookworm: http://www.oreilly.com/bookworm/index.html .. _Bookworm: http://www.oreilly.com/bookworm/index.html
.. _kindlegen: https://www.amazon.com/gp/feature.html?docId=1000765211 .. _kindlegen: https://www.amazon.com/gp/feature.html?docId=1000765211
@ -239,7 +239,7 @@ The exact behavior of how Emacs displays references is dependent on the variable
both the ``*note:`` part and the ``target-id``. This is generally the best way both the ``*note:`` part and the ``target-id``. This is generally the best way
to view Sphinx-based documents since they often make frequent use of links and to view Sphinx-based documents since they often make frequent use of links and
do not take this limitation into account. However, changing this variable do not take this limitation into account. However, changing this variable
affects how all Info documents are displayed and most due take this behavior affects how all Info documents are displayed and most do take this behavior
into account. into account.
If you want Emacs to display Info files produced by Sphinx using the value If you want Emacs to display Info files produced by Sphinx using the value