Skip to content

Commit b5b6f6d

Browse files
author
Sattar Gyulmamedov
committed
clear rst from markdown
1 parent 7115ae0 commit b5b6f6d

9 files changed

Lines changed: 463 additions & 15 deletions

File tree

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,5 @@ cython_debug/
161161
.DS_Store
162162
.python-version
163163
openapi*.json
164+
165+
mddocs/generated

‎mddocs/config/en/mkdocs.yml‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
site_name: onETL Docs
2+
docs_dir: '../../docs/en' # Where to find the English markdown files
3+
site_dir: '../../generated/en' # Where to put the English HTML files
4+
5+
theme:
6+
name: material
7+
# custom_dir: '../../overrides/' # This is where the customization of the theme lives
8+
# logo: assets/images/logo.svg # The logo is shared by all languages
9+
# favicon: assets/images/icon.svg # The favicon is shared by all languages
10+
language: en
11+
features:
12+
- navigation.indexes
13+
- content.tabs.link
14+
- content.code.copy
15+
- content.code.select
16+
- content.footnote.tooltips
17+
palette:
18+
- scheme: default
19+
toggle:
20+
icon: material/weather-night
21+
name: Switch to dark mode
22+
- scheme: slate
23+
toggle:
24+
icon: material/weather-sunny
25+
name: Switch to light mode
26+
locale: en
27+
highlightjs: true
28+
hljs_languages:
29+
- yaml
30+
31+
extra_css:
32+
- assets/stylesheets/autodoc_pydantic.css # CSS is shared by all languages
33+
34+
extra: # Language Selection
35+
onetl_logo_wide: "[![onETL logo](../en/assets/images/logo_wide.svg)](https://github.com/MobileTeleSystems/onetl)"
36+
repo_status_badge: "[![Repo status - Active](https://www.repostatus.org/badges/latest/active.svg)](https://github.com/MobileTeleSystems/onetl)"
37+
pypi_release_bage: "[![PyPI - Latest Release](https://img.shields.io/pypi/v/onetl)](https://pypi.org/project/onetl/)"
38+
pypi_license_bage: "[![PyPI - License](https://img.shields.io/pypi/l/onetl.svg)](https://github.com/MobileTeleSystems/onetl/blob/develop/LICENSE.txt)"
39+
pypi_pyversion_bage: "[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/onetl.svg)](https://pypi.org/project/onetl/)"
40+
pypi_downloads_bage: "[![PyPI - Downloads](https://img.shields.io/pypi/dm/onetl)](https://pypi.org/project/onetl/)"
41+
docs_status_badge: "[![Documentation - ReadTheDocs](https://readthedocs.org/projects/onetl/badge/?version=stable)](https://onetl.readthedocs.io/)"
42+
ci_status_badge: "[![Github Actions - latest CI build status](https://github.com/MobileTeleSystems/onetl/workflows/Tests/badge.svg)](https://github.com/MobileTeleSystems/onetl/actions)"
43+
precommit_badge: "[![pre-commit.ci Status](https://results.pre-commit.ci/badge/github/MobileTeleSystems/onetl/develop.svg)](https://results.pre-commit.ci/latest/github/MobileTeleSystems/onetl/develop)"
44+
test_cov_badge: "[![Test coverage - percent](https://codecov.io/gh/MobileTeleSystems/onetl/branch/develop/graph/badge.svg?token=RIO8URKNZJ)](https://codecov.io/gh/MobileTeleSystems/onetl)"
45+
etl_entities_link: "[`etl-entities`](https://github.com/MobileTeleSystems/etl-entities)"
46+
47+
alternate:
48+
49+
# Switch to English
50+
- name: English
51+
link: /en/
52+
lang: en
53+
54+
# Switch to Russian
55+
- name: Русский
56+
link: /ru/
57+
lang: ru
58+
59+
plugins:
60+
- autorefs
61+
- literate-nav:
62+
nav_file: nav.md
63+
- mkdocstrings:
64+
default_handler: python
65+
handlers:
66+
python:
67+
options:
68+
show_source: false
69+
show_root_heading: false
70+
show_root_toc_entry: false
71+
# extensions:
72+
# - griffe_sphinx
73+
# - griffe_pydantic: {schema: false}
74+
- macros
75+
- plantuml:
76+
puml_url: https://www.plantuml.com/plantuml/
77+
puml_keyword: plantuml
78+
# - i18n:
79+
# docs_structure: folder
80+
# languages:
81+
# - locale: en
82+
# default: true
83+
# name: English
84+
# build: true
85+
# - locale: ru
86+
# name: Русский
87+
# build: false
88+
89+
markdown_extensions:
90+
- footnotes
91+
- attr_list
92+
- md_in_html
93+
- admonition
94+
- pymdownx.details
95+
- pymdownx.critic
96+
# - markdown_include.include
97+
- pymdownx.snippets:
98+
base_path: ["."]
99+
check_paths: true
100+
- toc:
101+
permalink: true
102+
- pymdownx.tabbed:
103+
alternate_style: true
104+
- pymdownx.emoji:
105+
emoji_index: !!python/name:material.extensions.emoji.twemoji
106+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
107+
- pymdownx.superfences:
108+
custom_fences:
109+
- name: mermaid
110+
class: mermaid
111+
format: !!python/name:pymdownx.superfences.fence_code_format
112+
113+
# nav:
114+
# - "Concepts": concepts
115+
# - "Quickstart": quickstart
116+
# - "Logging": logging
117+
# - "Security": security
118+
# - "Contributing Guide": contributing
119+
# - "Plugins": plugins
120+
# - changelog:
121+
# - changelog/index.md
122+
# - "0.13.4": changelog/0.13.4
123+
# - "0.13.3": changelog/0.13.3
124+
# - "0.13.1": changelog/0.13.1
125+
# - "0.13.0": changelog/0.13.0
126+
# - "0.12.5": changelog/0.12.5
127+
# - "0.12.4": changelog/0.12.4
128+
# - "0.12.3": changelog/0.12.3
129+
# - "0.12.2": changelog/0.12.2
130+
# - "0.12.1": changelog/0.12.1
131+
# - "0.12.0": changelog/0.12.0
132+
# - "0.11.2": changelog/0.11.2
133+
# - "0.11.1": changelog/0.11.1
134+
# - "0.11.0": changelog/0.11.0
135+
# - "0.10.2": changelog/0.10.2
136+
# - "0.10.1": changelog/0.10.1
137+
# - "0.10.0": changelog/0.10.0
138+
# - "0.9.5": changelog/0.9.5
139+
# - "0.9.4": changelog/0.9.4
140+
# - "0.9.3": changelog/0.9.3
141+
# - "0.9.2": changelog/0.9.2
142+
# - "0.9.1": changelog/0.9.1
143+
# - "0.9.0": changelog/0.9.0
144+
# - "0.8.1": changelog/0.8.1
145+
# - "0.8.0": changelog/0.8.0
146+
# - "0.7.2": changelog/0.7.2
147+
# - "0.7.1": changelog/0.7.1
148+
# - "0.7.0": changelog/0.7.0
149+
# - "DB":
150+
# - db_/index.md
151+
# - "DBReader": db_/reader
152+
# - "DBWriter": db_/writer

‎mddocs/config/ru/mkdocs.yml‎

Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
site_name: Документация onETL
2+
docs_dir: '../../docs/ru' # Where to find the English markdown files
3+
site_dir: '../../generated/ru' # Where to put the English HTML files
4+
5+
theme:
6+
name: material
7+
custom_dir: '../../overrides/' # This is where the customization of the theme lives
8+
logo: assets/images/logo.svg # The logo is shared by all languages
9+
favicon: assets/images/icon.svg # The favicon is shared by all languages
10+
language: ru
11+
features:
12+
- navigation.indexes
13+
- content.tabs.link
14+
- content.code.copy
15+
- content.code.select
16+
palette:
17+
- scheme: default
18+
toggle:
19+
icon: material/weather-night
20+
name: Switch to dark mode
21+
- scheme: slate
22+
toggle:
23+
icon: material/weather-sunny
24+
name: Switch to light mode
25+
locale: ru
26+
highlightjs: true
27+
hljs_languages:
28+
- yaml
29+
30+
extra_css:
31+
- assets/stylesheets/autodoc_pydantic.css # CSS is shared by all languages
32+
33+
extra:
34+
onetl_logo_wide: "[![onETL logo](../ru/assets/images/logo_wide.svg)](https://github.com/MobileTeleSystems/onetl)"
35+
repo_status_badge: "[![Repo status - Active](https://www.repostatus.org/badges/latest/active.svg)](https://github.com/MobileTeleSystems/onetl)"
36+
pypi_release_bage: "[![PyPI - Latest Release](https://img.shields.io/pypi/v/onetl)](https://pypi.org/project/onetl/)"
37+
pypi_license_bage: "[![PyPI - License](https://img.shields.io/pypi/l/onetl.svg)](https://github.com/MobileTeleSystems/onetl/blob/develop/LICENSE.txt)"
38+
pypi_pyversion_bage: "[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/onetl.svg)](https://pypi.org/project/onetl/)"
39+
pypi_downloads_bage: "[![PyPI - Downloads](https://img.shields.io/pypi/dm/onetl)](https://pypi.org/project/onetl/)"
40+
docs_status_badge: "[![Documentation - ReadTheDocs](https://readthedocs.org/projects/onetl/badge/?version=stable)](https://onetl.readthedocs.io/)"
41+
ci_status_badge: "[![Github Actions - latest CI build status](https://github.com/MobileTeleSystems/onetl/workflows/Tests/badge.svg)](https://github.com/MobileTeleSystems/onetl/actions)"
42+
precommit_badge: "[![pre-commit.ci Status](https://results.pre-commit.ci/badge/github/MobileTeleSystems/onetl/develop.svg)](https://results.pre-commit.ci/latest/github/MobileTeleSystems/onetl/develop)"
43+
test_cov_badge: "[![Test coverage - percent](https://codecov.io/gh/MobileTeleSystems/onetl/branch/develop/graph/badge.svg?token=RIO8URKNZJ)](https://codecov.io/gh/MobileTeleSystems/onetl)"
44+
etl_entities_link: "[`etl-entities`](https://github.com/MobileTeleSystems/etl-entities)"
45+
alternate: # Language Selection
46+
47+
# Switch to English
48+
- name: English
49+
link: /en/
50+
lang: en
51+
52+
# Switch to Russian
53+
- name: Русский
54+
link: /ru/
55+
lang: ru
56+
57+
plugins:
58+
- autorefs
59+
- literate-nav:
60+
nav_file: nav.md
61+
- mkdocstrings:
62+
default_handler: python
63+
handlers:
64+
python:
65+
options:
66+
show_source: false
67+
show_root_heading: false
68+
show_root_toc_entry: false
69+
- macros
70+
- plantuml:
71+
puml_url: https://www.plantuml.com/plantuml/
72+
puml_keyword: plantuml
73+
# - i18n:
74+
# docs_structure: folder
75+
# languages:
76+
# - locale: en
77+
# name: English
78+
# build: false
79+
# - locale: ru
80+
# default: true
81+
# name: Русский
82+
# build: true
83+
84+
markdown_extensions:
85+
- attr_list
86+
- md_in_html
87+
- admonition
88+
- pymdownx.details
89+
- pymdownx.critic
90+
- pymdownx.snippets:
91+
base_path: ["."]
92+
check_paths: true
93+
- toc:
94+
permalink: true
95+
- pymdownx.tabbed:
96+
alternate_style: true
97+
- pymdownx.emoji:
98+
emoji_index: !!python/name:material.extensions.emoji.twemoji
99+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
100+
- pymdownx.superfences:
101+
custom_fences:
102+
- name: mermaid
103+
class: mermaid
104+
format: !!python/name:pymdownx.superfences.fence_code_format
105+
106+
# nav:
107+
# - "Архитектура библиотеки": concepts
108+
# - "Быстрый старт": quickstart
109+
# - "Руководство по участию": contributing
110+
# - "Безопасность": security
111+
# - "Логирование": logging
112+
# - "Плагины": plugins
113+
# - changelog:
114+
# - changelog/index.md
115+
# - "0.13.4": changelog/0.13.4
116+
# - "0.13.3": changelog/0.13.3
117+
# - "0.13.1": changelog/0.13.1
118+
# - "0.13.0": changelog/0.13.0
119+
# - "0.12.5": changelog/0.12.5
120+
# - "0.12.4": changelog/0.12.4
121+
# - "0.12.3": changelog/0.12.3
122+
# - "0.12.2": changelog/0.12.2
123+
# - "0.12.1": changelog/0.12.1
124+
# - "0.12.0": changelog/0.12.0
125+
# - "0.11.2": changelog/0.11.2
126+
# - "0.11.1": changelog/0.11.1
127+
# - "0.11.0": changelog/0.11.0
128+
# - "0.10.2": changelog/0.10.2
129+
# - "0.10.1": changelog/0.10.1
130+
# - "0.10.0": changelog/0.10.0
131+
# - "0.9.5": changelog/0.9.5
132+
# - "0.9.4": changelog/0.9.4
133+
# - "0.9.3": changelog/0.9.3
134+
# - "0.9.2": changelog/0.9.2
135+
# - "0.9.1": changelog/0.9.1
136+
# - "0.9.0": changelog/0.9.0
137+
# - "0.8.1": changelog/0.8.1
138+
# - "0.8.0": changelog/0.8.0
139+
# - "0.7.2": changelog/0.7.2
140+
# - "0.7.1": changelog/0.7.1
141+
# - "0.7.0": changelog/0.7.0

‎mddocs/docs/en/reference/database/create_partitions_cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# CLI for creating partitions { #create-partitions-cli }
22

33
<!-- TODO: check generation with original rst -->
4-
::: data_rentgen.db.scripts.create_partitions
4+
<!-- ::: data_rentgen.db.scripts.create_partitions -->

‎mddocs/docs/en/reference/database/refresh_analytic_views_cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ By default these materialized views are empty(`WITH NO DATA`).
2424
In order to fill these tables with data you need to run refresh script (see below).
2525

2626
<!-- TODO: check generation with original rst -->
27-
::: data_rentgen.db.scripts.refresh_analytic_views
27+
<!-- ::: data_rentgen.db.scripts.refresh_analytic_views -->

‎mddocs/docs/en/reference/database/seed_cli.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# CLI for seeding database { #db-seed-cli }
22

33
<!-- TODO: check generation with original rst -->
4-
::: data_rentgen.db.scripts.seed.__main__
4+
<!-- ::: data_rentgen.db.scripts.seed.__main__ -->

‎mddocs/docs/en/reference/http2kafka/configuration/index.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[openapi][configuration-http2kafka-openapi]
1111
[debug][configuration-http2kafka-debug]
1212

13-
::: data_rentgen.http2kafka.settings.Http2KafkaApplicationSettings
13+
<!-- TODO: Check the place -->
14+
<!-- ::: data_rentgen.http2kafka.settings.Http2KafkaApplicationSettings -->
1415

1516
::: data_rentgen.server.settings.ServerSettings

‎mddocs/docs/en/reference/server/configuration/debug.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ File ".../site-packages/uvicorn/middleware/proxy_headers.py", line 84, in __call
3232
return await self.app(scope, receive, send)
3333
```
3434

35-
:::{warning}
36-
This is only for development environment only. Do **NOT** use on production!
37-
:::
35+
!!! warning
36+
37+
This is only for development environment only. Do **NOT** use on production!
3838

3939
## Print debug logs on backend
4040

@@ -46,20 +46,20 @@ Server can add `X-Request-ID` header to responses, which allows to match request
4646

4747
This is done by `request_id` middleware, which is enabled by default and can configured as described below:
4848

49-
```{eval-rst}
50-
.. autopydantic_model:: data_rentgen.server.settings.request_id.RequestIDSettings
51-
```
49+
::: data_rentgen.server.settings.request_id.RequestIDSettings
5250

5351
## Print request ID to backend logs
5452

5553
This is done by adding a specific filter to logging handler:
5654

57-
```{eval-rst}
58-
.. dropdown:: ``logging.yml``
55+
??? note "logging.yml"
5956

60-
.. literalinclude:: ../../../../data_rentgen/logging/presets/plain.yml
61-
:emphasize-lines: 6-12,23-24,35
62-
```
57+
```yaml hl_lines="6-12 23-24 35"
58+
----8<----
59+
logging/presets/plain.yml
60+
----8<----
61+
```
62+
<!-- # :emphasize-lines: 6-12,23-24,35 -->
6363

6464
Resulting logs look like:
6565

0 commit comments

Comments
 (0)