Skip to content

Commit c9a5c76

Browse files
committed
Small refactoring
1 parent eef1817 commit c9a5c76

File tree

2 files changed

+21
-89
lines changed

2 files changed

+21
-89
lines changed

about.rst

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
==============
2-
О документации
3-
==============
1+
=================
2+
Об этом документе
3+
=================
44

5-
Эта документация собирает в себе опыт использования `Ceph <https://ceph.com>`_ несколькими специалистами.
6-
Вы можете улучшить её, задать вопрос `на GitHub <https://github.com/socketpair/ceph-docs>`_.
5+
Эта документация собирает в себе опыт использования
6+
`Ceph <https://ceph.com>`_ несколькими специалистами.
7+
Вы можете улучшить её, задав вопрос `на GitHub <https://github.com/socketpair/ceph-docs>`_,
8+
либо создав зull-request с исправлениями.
79

8-
Также, активное обсуждение вопросов о CEPH ведётся в `telegram-группе <https://t.me/ceph_ru>`_.
10+
Также, активное обсуждение вопросов о Ceph ведётся в
11+
`telegram-группе <https://t.me/ceph_ru>`_.
12+
13+
Мэйнтенйнером проекта является Коренберг Марк
14+
`socketpair@gmail.com <mailto: socketpair@gmail.com>`_.

conf.py

Lines changed: 9 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,5 @@
11
#!/usr/bin/env python3
2-
# -*- coding: utf-8 -*-
3-
#
4-
# Ceph FAQ documentation build configuration file, created by
5-
# sphinx-quickstart on Tue Jan 9 00:19:55 2018.
6-
#
7-
# This file is execfile()d with the current directory set to its
8-
# containing dir.
9-
#
10-
# Note that not all possible configuration values are present in this
11-
# autogenerated file.
12-
#
13-
# All configuration values have a default; values that are commented out
14-
# serve to show the default.
15-
16-
# If extensions (or modules to document with autodoc) are in another directory,
17-
# add these directories to sys.path here. If the directory is relative to the
18-
# documentation root, use os.path.abspath to make it absolute, like shown here.
19-
#
20-
# import os
21-
# import sys
22-
# sys.path.insert(0, os.path.abspath('.'))
23-
24-
25-
# -- General configuration ------------------------------------------------
26-
27-
# If your documentation needs a minimal Sphinx version, state it here.
28-
#
29-
# needs_sphinx = '1.0'
2+
import datetime
303

314
# Add any Sphinx extension module names here, as strings. They can be
325
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -38,20 +11,13 @@
3811

3912
# Add any paths that contain templates here, relative to this directory.
4013
templates_path = ['_templates']
41-
42-
# The suffix(es) of source filenames.
43-
# You can specify multiple suffix as a list of string:
44-
#
45-
# source_suffix = ['.rst', '.md']
4614
source_suffix = '.rst'
47-
48-
# The master toctree document.
4915
master_doc = 'index'
5016

5117
# General information about the project.
52-
#project = 'Ceph FAQ'
53-
# copyright = '2018, Korenberg Mark'
18+
project = 'Заметки о Ceph'
5419
author = 'Коренберг Марк'
20+
copyright = '%d, %s' % (datetime.datetime.now().year, author)
5521

5622
# The version info for the project you're documenting, acts as replacement for
5723
# |version| and |release|, also used in various other places throughout the
@@ -61,21 +27,16 @@
6127
version = '1.0'
6228
# The full version, including alpha/beta/rc tags.
6329
release = '1.0'
64-
65-
# The language for content autogenerated by Sphinx. Refer to documentation
66-
# for a list of supported languages.
67-
#
68-
# This is also used if you do content translation via gettext catalogs.
69-
# Usually you set "language" from the command line for these cases.
7030
language = 'ru'
7131

7232
html_theme = "sphinx_rtd_theme"
7333
html_static_path = ['_static']
74-
# Output file base name for HTML help builder.
7534
htmlhelp_basename = 'CephFAQdoc'
76-
77-
78-
# -- Options for LaTeX output ---------------------------------------------
35+
# https://sphinx-rtd-theme.readthedocs.io/en/latest/
36+
html_show_sourcelink = False
37+
html_theme_options = {
38+
'display_version': False,
39+
}
7940

8041
latex_elements = {
8142
# The paper size ('letterpaper' or 'a4paper').
@@ -99,40 +60,5 @@
9960
# (source start file, target name, title,
10061
# author, documentclass [howto, manual, or own class]).
10162
latex_documents = [
102-
(master_doc, 'CephFAQ.tex', 'Ceph FAQ Documentation',
103-
'Korenberg Mark', 'manual'),
104-
]
105-
106-
107-
# -- Options for manual page output ---------------------------------------
108-
109-
# One entry per manual page. List of tuples
110-
# (source start file, name, description, authors, manual section).
111-
man_pages = [
112-
(master_doc, 'cephfaq', 'Ceph FAQ Documentation',
113-
[author], 1)
114-
]
115-
116-
117-
# -- Options for Texinfo output -------------------------------------------
118-
119-
# Grouping the document tree into Texinfo files. List of tuples
120-
# (source start file, target name, title, author,
121-
# dir menu entry, description, category)
122-
texinfo_documents = [
123-
(master_doc, 'CephFAQ', 'Ceph FAQ Documentation',
124-
author, 'CephFAQ', 'One line description of project.',
125-
'Miscellaneous'),
63+
(master_doc, 'CephFAQ.tex', project, author, 'manual'),
12664
]
127-
128-
129-
130-
131-
# Example configuration for intersphinx: refer to the Python standard library.
132-
intersphinx_mapping = {'https://docs.python.org/': None}
133-
134-
# https://sphinx-rtd-theme.readthedocs.io/en/latest/
135-
html_show_sourcelink = False
136-
html_theme_options = {
137-
'display_version': False,
138-
}

0 commit comments

Comments
 (0)