Commit Graph

30 Commits

Author SHA1 Message Date
Ghassan Maslamani
d20646194c doc: update description
Update description about how `conf.py` is loaded/executed
2021-09-30 13:43:09 +03:00
Juan Luis Cano Rodríguez
1e49218993 Add tutorial section about extensions and themes 2021-06-17 00:21:42 +02:00
Juan Luis Cano Rodríguez
39b5564c63 Beginning of the tutorial, tweaks to introduction 2021-05-27 18:15:26 +02:00
Takeshi KOMIYA
3059a999b2 Close #8326: Rename master_doc to root_doc
To describe the purpose more accurately, the `master_doc` is now renamed
to `root_doc`.  The old name is still available.  But it is recommeneded
to use new one from now on.
2021-02-28 17:10:57 +09:00
Matthias Geier
84c6d693f4 DOC: Add favicon 2020-10-24 17:41:02 +02:00
Chris Mayo
9bac86a2fc Fix typo sphinx-buid in internationalization figure 2020-08-03 19:30:38 +01:00
Takeshi KOMIYA
f3811a1c36 doc: Remove broken PDF image
It was added unexpectedly in #7924.
2020-07-11 00:28:22 +09:00
Takeshi KOMIYA
d2fdc851fa doc: Add translation.png to build latexpdf successfully 2020-07-07 22:19:21 +09:00
Tetsuo Koyama
7cc27eea3d 🔧 ⚠️ (#7292) 2020-03-18 16:18:11 +09:00
Septatrix
97133d4bf0 Configure plantuml to generate svg files (fixes #7134) 2020-03-10 19:09:31 +01:00
Tetsuo Koyama
7fbd9c02d0 🎨 Fixed issue #6789 2019-11-04 20:28:24 +09:00
Jon Dufresne
bade33c7e4 Remove unnecessary encoding cookie from Python source files
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
2018-12-16 12:22:12 -08: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
Stephen Finucane
d380617c3b doc: Add "internationalization" to the usage guide
This is added to the new "advanced" subsection.

Signed-off-by: Stephen Finucane <stephen@that.guru>
2018-11-16 13:20:46 +01: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
Takeshi KOMIYA
b27fbc4aa5 Remove html_use_smartypants (deprecated) 2017-05-03 17:27:32 +09:00
Takeshi KOMIYA
361a34257b Remove deprecated feature: latex_keep_old_macro_names 2017-04-27 21:49:19 +09:00
adrian5
680030b568 Update conf.py.txt
I'm not entirely sure what this line is trying to say, but is needs rewriting. Modify my commit, if necessary.
2017-02-03 16:30:26 +01:00
Takeshi KOMIYA
5d715cb148 Drop deprecated options for latex builder 2017-01-05 13:48:41 +09:00
jfbu
f2091e0512 fix bottom of conf.py.txt 2016-11-06 12:41:22 +01:00
jfbu
da271b6373 fix `\t` which got converted to tab in conf.py.txt 2016-11-06 12:29:17 +01:00
Philip Molloy
47bae16513 Fix indentation in conf.py 2016-10-25 17:03:56 -04:00
Takeshi KOMIYA
cbe0ce6beb Add example of conf.py to doc/config.rst 2016-10-12 18:40:19 +09:00
Ville Skyttä
302c695048 Run *.png through zopflipng -m
Before: 2334583 bytes
After:  2136324 bytes
2016-07-07 18:34:18 +03:00
Lars Buitinck
5a13bce2e2 compress static PNG images with optipng -o10
Average reduction in file size of 20%.
2014-07-22 13:42:00 +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
20279b07a4 New doc design "sphinx13". 2013-01-18 23:17:11 +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
bf3e2cc208 Refreshed logo, by Panos Laganakos. 2008-03-23 15:08:57 +00:00
Georg Brandl
5f78bc436b Use Windows-friendlier dirnames. 2008-03-21 15:20:50 +00:00