diff --git a/README.rst b/README.rst index 2d8d919..14276e4 100644 --- a/README.rst +++ b/README.rst @@ -4,7 +4,7 @@ В руководстве подробно описан процесс генерации документации с помощью связки reStructuredText, Python Sphinx, GitHub и сервиса Read the Docs. -Руководство находится на https://sphinx-ru.readthedocs.org +Руководство находится на https://sphinx-ru.readthedocs.io/ru/latest/ Авторские права diff --git a/docs/agreements.rst b/docs/agreements.rst index 2f9debc..f3ca6fa 100644 --- a/docs/agreements.rst +++ b/docs/agreements.rst @@ -1,3 +1,6 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 + .. _agreement-label: Соглашения diff --git a/docs/community.rst b/docs/community.rst index 8ae526e..ec1b14c 100644 --- a/docs/community.rst +++ b/docs/community.rst @@ -1,3 +1,6 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 + Русскоязычное сообщество LibreOffice ==================================== @@ -6,7 +9,6 @@ Новости ------- -* Сообщество в Google Plus: https://plus.google.com/communities/114023476906934509704 * Группа ВКонтакте: http://vk.com/libreoffice * Твиттер: http://twitter.com/LibreOffice_ru * Facebook: https://www.facebook.com/ru.libreoffice.org diff --git a/docs/conf.py b/docs/conf.py index c5316a4..c26ef29 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,7 +29,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.pngmath', + 'sphinx.ext.imgmath', ] # Add any paths that contain templates here, relative to this directory. @@ -194,7 +194,7 @@ 'preamble': '\\usepackage[utf8]{inputenc}', 'babel': '\\usepackage[russian]{babel}', 'cmappkg': '\\usepackage{cmap}', -'fontenc': '\usepackage[T1,T2A]{fontenc}', +'fontenc': '\\usepackage[T1,T2A]{fontenc}', 'utf8extra':'\\DeclareUnicodeCharacter{00A0}{\\nobreakspace}', } diff --git a/docs/faq.rst b/docs/faq.rst index 0ecf065..08ffd07 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -1,3 +1,6 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 + .. _faq-chapter: Часто задаваемые вопросы diff --git a/docs/git.rst b/docs/git.rst index b474c8a..d580a43 100644 --- a/docs/git.rst +++ b/docs/git.rst @@ -1,3 +1,5 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 .. _git-chapter: diff --git a/docs/index.rst b/docs/index.rst index 99f7ad6..27007a8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -28,6 +28,6 @@ faq agreements win-sphinx - + community * :ref:`genindex` diff --git a/docs/knownissues.rst b/docs/knownissues.rst index c0b894e..c4335f9 100644 --- a/docs/knownissues.rst +++ b/docs/knownissues.rst @@ -1,3 +1,5 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 .. _knownissues-chapter: diff --git a/docs/preface.rst b/docs/preface.rst index ef4d3fd..841872a 100644 --- a/docs/preface.rst +++ b/docs/preface.rst @@ -1,3 +1,6 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 + .. Список автозамен: .. |ло| replace:: LibreOffice .. |lo| replace:: LibreOffice diff --git a/docs/rst-markup.rst b/docs/rst-markup.rst index d884d0c..baf2a3d 100644 --- a/docs/rst-markup.rst +++ b/docs/rst-markup.rst @@ -1,3 +1,6 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 + .. Список автозамен: .. |rest| replace:: reStructuredText diff --git a/docs/rtd-gh.rst b/docs/rtd-gh.rst index 40d6289..a3a6711 100644 --- a/docs/rtd-gh.rst +++ b/docs/rtd-gh.rst @@ -1,3 +1,5 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 .. _rtd-gh-chapter: diff --git a/docs/sphinx-markup.rst b/docs/sphinx-markup.rst index 66077ad..9ccca72 100644 --- a/docs/sphinx-markup.rst +++ b/docs/sphinx-markup.rst @@ -1,3 +1,5 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 .. _sphinx-markup: diff --git a/docs/sphinx.rst b/docs/sphinx.rst index 86f7a7d..603695c 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -1,3 +1,6 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 + .. _sphinx-chapter: =============================== @@ -53,69 +56,21 @@ Sphinx доступен для всех основных операционны Программа задаст ряд вопросов. Все настройки можно будет позже изменить в файле ``conf.py``. .. code-block:: python - - > Корневой каталог документации. По умолчанию текущий каталог. - > Root path for the documentation [.]: - + > Сделать ли раздельные папки исходников и готовых страниц - Да > Separate source and build directories (y/N) [n]: y - > Префикс для директорий с шаблонами и статическими файлами. - > Name prefix for templates and static dir [_]: - > Название проекта. Для начала лучше вводить на латинице. > Project name: > Имя автора/авторов. Для начала лучше вводить на латинице. > Author name(s): - > Версия проекта - > Project version: - > Номер релиза проекта - > Project release [1]: - - > Расширение исходного файла. По умолчанию .rst. - > Source file suffix [.rst]: - - > Имя мастер-документа. По умолчанию index.rst. - > Name of your master document (without suffix) [index]: - - > Генерировать ePub версию документации? - > Do you want to use the epub builder (y/n) [n]: - - > Автоматически вставлять docstrings из модулей - > autodoc: automatically insert docstrings from modules (y/n) [n]: + > Project release []: - > - > doctest: automatically test code snippets in doctest blocks (y/n) [n]: - - > - > intersphinx: link between Sphinx documentation of different projects (y/n) [n]: - - > - > todo: write "todo" entries that can be shown or hidden on build (y/n) [n]: - - > - > coverage: checks for documentation coverage (y/n) [n]: - - > Использовать модуль pngmath для вставки формул в формате png - > pngmath: include math, rendered as PNG images (y/n) [n]: - - > Использовать модуль mathjax для вставки формул в формате MathJax - > mathjax: include math, rendered in the browser by MathJax (y/n) [n]: y - - > - > ifconfig: conditional inclusion of content based on config values (y/n) [n]: - - > - > viewcode: include links to the source code of documented Python objects (y/n) [n]: - - > Создать Makefile - да - > Create Makefile? (y/n) [y]: - - > Сделать ли файл .bat, - нет, если у вас Linux - > Create Windows command file? (Y/n) [y]: n () + > Язык проекта + > Project language [en]: ru После ответа на вопросы будут созданы файлы ``index.rst``, ``conf.py``, ``Makefile``, ``_build``, ``_static``, ``_templates``. :: @@ -373,9 +328,9 @@ ______ Режим отображения формул ~~~~~~~~~~~~~~~~~~~~~~~~ -Формулы в Sphinx могут отображаться с помощью одного из двух расширений: ``sphinx.ext.pngmath`` или ``sphinx.ext.mathjax``. Первое расширение отображает формулы как изображения в png формате. Другое расширение использует JavaScript библиотеку ``mathjax`` для отображения формул. +Формулы в Sphinx могут отображаться с помощью одного из двух расширений: ``sphinx.ext.imgmath`` или ``sphinx.ext.mathjax``. Первое расширение отображает формулы как изображения в png формате. Другое расширение использует JavaScript библиотеку ``mathjax`` для отображения формул. -Я предпочитаю использовать ``sphinx.ext.mathjax``, так как оно позволяет масштабировать формулы без потери качества отображения. Но для сервиса Read The Docs нужно использовать ``sphinx.ext.pngmath``. +Я предпочитаю использовать ``sphinx.ext.mathjax``, так как оно позволяет масштабировать формулы без потери качества отображения. Но для сервиса Read The Docs нужно использовать ``sphinx.ext.imgmath``. Указать Sphinx какое расширение использовать можно в конфигурационном файле ``conf.py``, в строке ``extensions``. @@ -388,7 +343,7 @@ ______ или extensions = [ - 'sphinx.ext.pngmath', + 'sphinx.ext.imgmath', ] .. warning:: Использовать одновременно оба расширения нельзя. diff --git a/docs/win-sphinx.rst b/docs/win-sphinx.rst index d43f97a..285e916 100644 --- a/docs/win-sphinx.rst +++ b/docs/win-sphinx.rst @@ -1,3 +1,5 @@ +.. meta:: + :http-equiv=Content-Type: text/html; charset=utf-8 .. _win-sphinx: