Commit bee40252 authored by René Schöne's avatar René Schöne
Browse files

Switch from sphinx to mkdocs

parent 36f7affd
Pipeline #8802 passed with stages
in 9 minutes and 55 seconds
.. RagConnect documentation master file, created by
sphinx-quickstart on Fri Aug 28 10:16:26 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
RagConnect Documentation
========================
`RagConnect <https://git-st.inf.tu-dresden.de/jastadd/ragconnect>`_ is a preprocessor to enable easy connection to/from models based on `Reference Attribute Grammars <http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.108.8792&rep=rep1&type=pdf>`_ and `Relation Reference Attribute Grammars <https://doi.org/10.1016/j.cola.2019.100940>`_ built with `JastAdd <http://jastadd.org/>`_.
.. toctree::
:maxdepth: 2
:caption: Contents:
use_cases.md
adding.md
inner-workings.md
using.md
extending.md
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=public
if "%1" == "" goto help
%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.http://sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd
site_name: RagConnect Documentation
nav:
- use_cases.md
- adding.md
- inner-workings.md
- using.md
- extending.md
- API documentation: ragdoc/index.html
theme:
name: readthedocs
custom_dir: custom_theme/
plugins:
- search
- git-revision-date:
as_datetime: True
- macros
repo_url: https://git-st.inf.tu-dresden.de/jastadd/ragconnect
site_dir: ../public
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment