mozilla
/
treeherder
зеркало из https://github.com/mozilla/treeherder.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
treeherder/mkdocs.yml

51 строка
1.6 KiB
YAML
Исходник Обычный вид История

Bug 1466084 - Docs: Switch to MkDocs and Material theme (#4565) Switches from Sphinx to MkDocs, since it: * supports Markdown natively without requiring hacks like `eval_rst` * validates inline links, ensuring that they are not broken * has a more pleasant live-reloading dev-server * supports the nicer looking mkdocs-material theme * is a third of the size of Sphinx (including deps) The theme change is now possible since Read the Docs have just started supporting use of custom themes (previously they would override the theme and use `readthedocs` theme regardless).
2019-02-06 22:34:08 +03:00
docs_dir: 'docs'
site_dir: '.build-docs'
strict: true
use_directory_urls: false
site_name: 'Treeherder Docs'
site_url: 'https://treeherder.readthedocs.io'
repo_name: 'mozilla/treeherder'
repo_url: 'https://github.com/mozilla/treeherder'
# https://squidfunk.github.io/mkdocs-material/getting-started/#configuration
theme:
name: 'material'
# https://squidfunk.github.io/mkdocs-material/getting-started/#extensions
markdown_extensions:
- admonition
- codehilite:
guess_lang: false
- toc:
permalink: true
# Fixes fenced code blocks within lists.
- 'pymdownx.superfences':
disable_indented_code_blocks: True
# Allows index.md to include the repo root README.
- 'pymdownx.snippets':
check_paths: True
# Required so that 2 space indents within lists work the same as
# GitHub and Prettier's markdown implementation.
- mdx_truly_sane_lists
# http://www.mkdocs.org/user-guide/writing-your-docs/#configure-pages-and-navigation
nav:
- About: 'index.md'
Bug 1165259 - Add infrastructure documentation (#4766) - Adds a new "infrastructure" section to the docs, which describes architecture, administration and troubleshooting (fixes bug 1165259). - Adds code comments to any deployment-related files in the repository. - Adds documentation for the various ways in which users can access Treeherder data (fixes bug 1335172). - Reorganises the structure of some of the existing non-infrastructure docs, to make the documentation easier to navigate.
2019-03-12 00:39:34 +03:00
- Development:
Bug 1466084 - Docs: Switch to MkDocs and Material theme (#4565) Switches from Sphinx to MkDocs, since it: * supports Markdown natively without requiring hacks like `eval_rst` * validates inline links, ensuring that they are not broken * has a more pleasant live-reloading dev-server * supports the nicer looking mkdocs-material theme * is a third of the size of Sphinx (including deps) The theme change is now possible since Read the Docs have just started supporting use of custom themes (previously they would override the theme and use `readthedocs` theme regardless).
2019-02-06 22:34:08 +03:00
- Installation: 'installation.md'
Split out the /docs automated test section and enhance it a bit
2019-07-17 19:41:43 +03:00
- Testing: 'testing.md'
Bug 1165259 - Add infrastructure documentation (#4766) - Adds a new "infrastructure" section to the docs, which describes architecture, administration and troubleshooting (fixes bug 1165259). - Adds code comments to any deployment-related files in the repository. - Adds documentation for the various ways in which users can access Treeherder data (fixes bug 1335172). - Reorganises the structure of some of the existing non-infrastructure docs, to make the documentation easier to navigate.
2019-03-12 00:39:34 +03:00
- Loading Pulse data: 'pulseload.md'
Bug 1466084 - Docs: Switch to MkDocs and Material theme (#4565) Switches from Sphinx to MkDocs, since it: * supports Markdown natively without requiring hacks like `eval_rst` * validates inline links, ensuring that they are not broken * has a more pleasant live-reloading dev-server * supports the nicer looking mkdocs-material theme * is a third of the size of Sphinx (including deps) The theme change is now possible since Read the Docs have just started supporting use of custom themes (previously they would override the theme and use `readthedocs` theme regardless).
2019-02-06 22:34:08 +03:00
- Code Style: 'code_style.md'
Documentation Update - Accessibility page (#5920) Include section on general practices and color and style modifications, and resources.
2020-02-07 23:44:51 +03:00
- Accessibility: 'accessibility.md'
Bug 1466084 - Docs: Switch to MkDocs and Material theme (#4565) Switches from Sphinx to MkDocs, since it: * supports Markdown natively without requiring hacks like `eval_rst` * validates inline links, ensuring that they are not broken * has a more pleasant live-reloading dev-server * supports the nicer looking mkdocs-material theme * is a third of the size of Sphinx (including deps) The theme change is now possible since Read the Docs have just started supporting use of custom themes (previously they would override the theme and use `readthedocs` theme regardless).
2019-02-06 22:34:08 +03:00
- Common tasks: 'common_tasks.md'
- Backend tasks: 'backend_tasks.md'
Bug 1165259 - Add infrastructure documentation (#4766) - Adds a new "infrastructure" section to the docs, which describes architecture, administration and troubleshooting (fixes bug 1165259). - Adds code comments to any deployment-related files in the repository. - Adds documentation for the various ways in which users can access Treeherder data (fixes bug 1335172). - Reorganises the structure of some of the existing non-infrastructure docs, to make the documentation easier to navigate.
2019-03-12 00:39:34 +03:00
- Infrastructure:
- Architecture: 'infrastructure/architecture.md'
- Administration: 'infrastructure/administration.md'
- Troubleshooting: 'infrastructure/troubleshooting.md'
- Accessing data: 'accessing_data.md'
- Submitting data: 'submitting_data.md'
- SETA: 'seta.md'
- Manual test cases: 'testcases.md'