[ADD] docs first commit

This commit is contained in:
Mohammad Awais 2024-04-13 16:54:40 +05:00 committed by GitHub
parent 67c173a6ec
commit 168045cd17
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 35 additions and 23 deletions

View File

@ -5,28 +5,16 @@
# Required # Required
version: 2 version: 2
# Set the OS, Python version and other tools you might need # Set the version of Python and other tools you might need
build: # build:
os: ubuntu-22.04 # os: ubuntu-22.04
tools: # tools:
python: "3.12" # python: "3.10"
# You can also specify other tool versions:
# nodejs: "19"
# rust: "1.64"
# golang: "1.19"
# Build documentation in the "docs/" directory with Sphinx mkdocs:
sphinx: configuration: mkdocs.yml
configuration: docs/conf.py
# Optionally build your docs in additional formats such as PDF and ePub # Optionally declare the Python requirements required to build your docs
# formats: python:
# - pdf install:
# - epub - requirements: docs/requirements.txt
# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
# python:
# install:
# - requirements: docs/requirements.txt

8
docs/index.md Normal file
View File

@ -0,0 +1,8 @@
{!README.md!}
# Welcome to Odoo SaaS on K8s documentation!
!!! note
This project is under active development.

16
mkdocs.yml Normal file
View File

@ -0,0 +1,16 @@
site_name: Basic MkDocs Example Project
theme:
name: readthedocs
highlightjs: true
plugins:
- search
- mkdocstrings:
handlers:
# See: https://mkdocstrings.github.io/python/usage/
python:
options:
docstring_style: sphinx
markdown_extensions:
- markdown_include.include:
base_path: .
- admonition