-
Notifications
You must be signed in to change notification settings - Fork 7
Add English mkdocs #367
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Add English mkdocs #367
Changes from 15 commits
431a521
edb8b00
c2bff69
5d2463e
6b786cc
08188ef
8a8f515
bf69d94
a7808b1
52836a0
d48ddfc
efdb81a
3680bc7
a6ca902
1a01d99
b72cdfc
a65cf01
7020020
9b1b918
989bfe5
f1e2cee
1b0d1c9
cd4aa91
9d06b75
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -78,6 +78,9 @@ docs/_build/ | |
| docs/build | ||
| docs/*.tar.gz | ||
|
|
||
| # Sphinx mddocs | ||
| mddocs/_build/ | ||
|
|
||
| # PyBuilder | ||
| target/ | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| site_name: onETL Docs | ||
| docs_dir: '../../docs/en' # Where to find the English markdown files | ||
| site_dir: '../../generated/en' # Where to put the English HTML files | ||
|
|
||
| theme: | ||
| name: material | ||
| custom_dir: '../../overrides/' # This is where the customization of the theme lives | ||
| logo: assets/images/logo.svg # The logo is shared by all languages | ||
| favicon: assets/images/icon.svg # The favicon is shared by all languages | ||
| language: en | ||
| features: | ||
| - navigation.indexes | ||
| - content.tabs.link | ||
| - content.code.copy | ||
| - content.code.select | ||
| palette: | ||
| - scheme: default | ||
| toggle: | ||
| icon: material/weather-night | ||
| name: Switch to dark mode | ||
| - scheme: slate | ||
| toggle: | ||
| icon: material/weather-sunny | ||
| name: Switch to light mode | ||
| locale: en | ||
| highlightjs: true | ||
| hljs_languages: | ||
| - yaml | ||
|
|
||
| extra_css: | ||
| - assets/stylesheets/autodoc_pydantic.css # CSS is shared by all languages | ||
|
|
||
| extra: # Language Selection | ||
| onetl_logo_wide: "[](https://github.com/MobileTeleSystems/onetl)" | ||
| repo_status_badge: "[](https://github.com/MobileTeleSystems/onetl)" | ||
| pypi_release_bage: "[](https://pypi.org/project/onetl/)" | ||
| pypi_license_bage: "[](https://github.com/MobileTeleSystems/onetl/blob/develop/LICENSE.txt)" | ||
| pypi_pyversion_bage: "[](https://pypi.org/project/onetl/)" | ||
| pypi_downloads_bage: "[](https://pypi.org/project/onetl/)" | ||
| docs_status_badge: "[](https://onetl.readthedocs.io/)" | ||
| ci_status_badge: "[](https://github.com/MobileTeleSystems/onetl/actions)" | ||
| precommit_badge: "[](https://results.pre-commit.ci/latest/github/MobileTeleSystems/onetl/develop)" | ||
| test_cov_badge: "[](https://codecov.io/gh/MobileTeleSystems/onetl)" | ||
| alternate: | ||
|
|
||
| # Switch to English | ||
| - name: English | ||
| link: /en/ | ||
| lang: en | ||
|
|
||
| # Switch to Russian | ||
| - name: Русский | ||
| link: /ru/ | ||
| lang: ru | ||
|
|
||
| plugins: | ||
| - autorefs | ||
| - mkdocstrings: | ||
| default_handler: python | ||
| handlers: | ||
| python: | ||
| options: | ||
| show_source: false | ||
| show_root_heading: false | ||
| show_root_toc_entry: false | ||
| - macros | ||
| - plantuml: | ||
| puml_url: https://www.plantuml.com/plantuml/ | ||
| puml_keyword: plantuml | ||
| # - i18n: | ||
| # docs_structure: folder | ||
| # languages: | ||
| # - locale: en | ||
| # default: true | ||
| # name: English | ||
| # build: true | ||
| # - locale: ru | ||
| # name: Русский | ||
| # build: false | ||
|
|
||
| markdown_extensions: | ||
| - attr_list | ||
| - md_in_html | ||
| - admonition | ||
| - pymdownx.details | ||
| - pymdownx.critic | ||
| - pymdownx.snippets: | ||
| base_path: ["."] | ||
| check_paths: true | ||
| - toc: | ||
| permalink: true | ||
| - pymdownx.tabbed: | ||
| alternate_style: true | ||
| - pymdownx.emoji: | ||
| emoji_index: !!python/name:material.extensions.emoji.twemoji | ||
| emoji_generator: !!python/name:material.extensions.emoji.to_svg | ||
| - pymdownx.superfences: | ||
| custom_fences: | ||
| - name: mermaid | ||
| class: mermaid | ||
| format: !!python/name:pymdownx.superfences.fence_code_format | ||
|
|
||
| nav: | ||
| - "Concepts": concepts | ||
| - "Quickstart": quickstart | ||
| - "Logging": logging | ||
| - "Security": security | ||
| - "Contributing Guide": contributing | ||
| - "Plugins": plugins | ||
| - changelog: | ||
| - changelog/index.md | ||
| - "0.13.4": changelog/0.13.4 | ||
| - "0.13.3": changelog/0.13.3 | ||
| - "0.13.1": changelog/0.13.1 | ||
| - "0.13.0": changelog/0.13.0 | ||
| - "0.12.5": changelog/0.12.5 | ||
| - "0.12.4": changelog/0.12.4 | ||
| - "0.12.3": changelog/0.12.3 | ||
| - "0.12.2": changelog/0.12.2 | ||
| - "0.12.1": changelog/0.12.1 | ||
| - "0.12.0": changelog/0.12.0 | ||
| - "0.11.2": changelog/0.11.2 | ||
| - "0.11.1": changelog/0.11.1 | ||
| - "0.11.0": changelog/0.11.0 | ||
| - "0.10.2": changelog/0.10.2 | ||
| - "0.10.1": changelog/0.10.1 | ||
| - "0.10.0": changelog/0.10.0 | ||
| - "0.9.5": changelog/0.9.5 | ||
| - "0.9.4": changelog/0.9.4 | ||
| - "0.9.3": changelog/0.9.3 | ||
| - "0.9.2": changelog/0.9.2 | ||
| - "0.9.1": changelog/0.9.1 | ||
| - "0.9.0": changelog/0.9.0 | ||
| - "0.8.1": changelog/0.8.1 | ||
| - "0.8.0": changelog/0.8.0 | ||
| - "0.7.2": changelog/0.7.2 | ||
| - "0.7.1": changelog/0.7.1 | ||
| - "0.7.0": changelog/0.7.0 | ||
| - "DB": | ||
| - db_/index.md | ||
|
||
| - "DBReader": db_/reader | ||
| - "DBWriter": db_/writer | ||
Uh oh!
There was an error while loading. Please reload this page.