diff --git a/.gitignore b/.gitignore index e61f4ce5..cdca306d 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ gh-pages/ /.cr-release-packages .vscode/ __pycache__ +/site diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..8357ff8a --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +# Welcome to the documentation of ansible awx-operator diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..3e3a2e5e --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,12 @@ +cairosvg==2.7.0 +markdown-exec>=1.6.0 +mkdocs-ansible[lock]>=0.1.6 +mkdocs-gen-files>=0.4.0 +mkdocs-material-extensions>=1.1.1 +mkdocs-material>=9.1.15 +mkdocs==1.4.3 +mkdocstrings-python>=1.1.0 +mkdocstrings>=0.22.0 +pillow==9.5.0 +pipdeptree==2.7.1 +pymdown-extensions==10.0.1 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..8f8a1f52 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,82 @@ +--- +site_name: awx-operator +site_url: https://awx-operator.readthedocs.io/ +repo_url: https://github.com/ansible/awx-operator +edit_uri: blob/devel/docs/ +docs_dir: docs +strict: true +use_directory_urls: false + +theme: + name: "material" + features: + - content.code.copy + - content.action.edit + - navigation.expand + - navigation.sections + - navigation.instant + - navigation.indexes + - navigation.tracking + - toc.integrate + palette: + - media: "(prefers-color-scheme: light)" + primary: teal + accent: blue + scheme: default + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: teal + accent: blue + toggle: + icon: material/brightness-4 + name: Switch to light mode + +nav: + - home: index.md + - debugging.md + - migration.md + +plugins: + - autorefs + - markdown-exec + - search + - mkdocstrings: + handlers: + python: + paths: [src] + options: + # Sphinx is for historical reasons, but we could consider switching if needed + # https://mkdocstrings.github.io/griffe/docstrings/ + docstring_style: sphinx + merge_init_into_class: yes + show_submodules: yes + import: + - url: https://docs.ansible.com/ansible/latest/objects.inv + domains: [py, std] + +markdown_extensions: + - admonition + - def_list + - footnotes + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets: + check_paths: true + - pymdownx.superfences + - pymdownx.magiclink: + repo_url_shortener: true + repo_url_shorthand: true + social_url_shorthand: true + social_url_shortener: true + user: facelessuser + repo: pymdown-extensions + normalize_issue_symbols: true + - pymdownx.tabbed: + alternate_style: true + - toc: + toc_depth: 2 + permalink: true