MT#57728 Introduce Read the Docs

This is a first commit introducing general readthedocs wiki
structure.

It introduced the following main chapters:
- Overview (is a symlink to the README.md), the readthedocs
  parses the markdown from here and creates the overview page

Mainly files required for RTD building.

Change-Id: Iad5626da6cff991f272cb0b2260888bba568f622
mr13.3.1
Donat Zenichev 2 years ago
parent c4cf9d7252
commit c0e7b0ccba

@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#
# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
# SOURCEDIR = source
BUILDDIR = _build
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
.PHONY: help Makefile
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

@ -0,0 +1,32 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
from datetime import date
project = 'sems'
copyright = str(date.today().year) + ', Sipwise'
author = 'Sipwise'
release = 'master'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = ["myst_parser",
"sphinx_rtd_theme"]
myst_heading_anchors = 3
templates_path = ['_templates']
exclude_patterns = ['_build']
master_doc = 'index'
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'sphinx_rtd_theme'
htmlhelp_basename = 'semsdoc'

@ -0,0 +1,12 @@
.. _SEMS: https://github.com/sipwise/sems
.. _rtpengine: https://github.com/sipwise/rtpengine
.. _Sipwise: https://www.sipwise.com
.. _Kamailio: https://www.kamailio.org/
Welcome to the SEMS Project Documentation
==============================================
.. toctree::
:maxdepth: 4
Overview <overview>

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
set BUILDDIR=build
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

@ -0,0 +1 @@
../README.md

@ -0,0 +1,2 @@
myst-parser==2.0.0
sphinx-rtd-theme>=1.2
Loading…
Cancel
Save