diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 00000000..5c76c8b0 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,9 @@ +version: 2 + +mkdocs: + configuration: mkdocs.yml + fail_on_warning: false + +python: + install: + - requirements: docs/requirements.txt diff --git a/docs/contributing.md b/docs/contributing.md new file mode 120000 index 00000000..44fcc634 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 120000 index 00000000..32d46ee8 --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/docs/license.md b/docs/license.md new file mode 120000 index 00000000..ea5b6064 --- /dev/null +++ b/docs/license.md @@ -0,0 +1 @@ +../LICENSE \ No newline at end of file diff --git a/PATHS.md b/docs/paths.md similarity index 100% rename from PATHS.md rename to docs/paths.md diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..fe0e3663 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,22 @@ +Babel==2.9.1 +click==8.1.2 +ghp-import==2.0.2 +gitdb==4.0.9 +GitPython==3.1.27 +importlib-metadata==4.11.3 +Jinja2==3.1.1 +Markdown==3.3.6 +MarkupSafe==2.1.1 +mergedeep==1.3.4 +mkdocs==1.3.0 +mkdocs-git-revision-date-localized-plugin==1.0.1 +packaging==21.3 +pyparsing==3.0.7 +python-dateutil==2.8.2 +pytz==2022.1 +PyYAML==6.0 +pyyaml_env_tag==0.1 +six==1.16.0 +smmap==5.0.0 +watchdog==2.1.7 +zipp==3.7.0 diff --git a/docs/users.md b/docs/users.md new file mode 120000 index 00000000..beca4e13 --- /dev/null +++ b/docs/users.md @@ -0,0 +1 @@ +../USERS.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..a324d0a2 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,53 @@ +# Test this locally with: +# $ docker run --rm -it -v $(pwd):$(pwd) --workdir $(pwd) python:3 bash +# # pip install -r docs/requirements.txt +# # mkdocs serve +# # mkdocs build +# $ ls -lah site/ +site_name: helmfile +site_author: Helmfile Authors + +repo_name: helmfile/helmfile/ +repo_url: https://github.com/helmfile/helmfile/ +edit_uri: '' + +docs_dir: docs + +nav: + - Home: index.md + - Getting Started: + - Paths Overview: paths.md + - Advanced Features: + - Best Practices Guide: writing-helmfile.md + - Advanced Features: advanced-features.md + - Secrets: remote-secrets.md + - Shared Configuration Across Teams: shared-configuration-across-teams.md + - About: + - Users: users.md + - License: license.md + - Contributing: contributing.md + +theme: + name: readthedocs + features: + - navigation.tabs + collapse_navigation: false + hljs_languages: + - yaml + - dockerfile + +markdown_extensions: + # meta, toc, table and fenced_code extensions are included by default + - extra + - admonition + - smarty + - sane_lists + - nl2br + - toc: + permalink: true + +plugins: + - search + - git-revision-date-localized: + type: date + fallback_to_build_date: true