From 3647753a509f655ee1df2c9eabd6094de5a97a23 Mon Sep 17 00:00:00 2001 From: Jaikinator Date: Mon, 16 Oct 2023 16:20:56 +0200 Subject: [PATCH] fixed Readme --- .github/workflows/documentation.yml | 3 +++ source/index.rst | 13 +++++-------- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d7be839..15a4784 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -26,6 +26,9 @@ jobs: - name: Sphinx build run: | + cp README.md ./source/README.md + cp LICENSE ./source/LICENSE + cp Pictures ./source/Pictures sphinx-apidoc -o source scraibe/ sphinx-build -M html source docs make html diff --git a/source/index.rst b/source/index.rst index eaecbd1..1eaceef 100644 --- a/source/index.rst +++ b/source/index.rst @@ -1,22 +1,19 @@ Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligence Based Environment's documentation! ===================================================================================================================== -Readme File -=========== - - - .. automodule:: scraibe - :members: + :members: + .. toctree:: :maxdepth: 2 :caption: Contents: - .. include:: ../README.md - :parser: myst_parser.sphinx_ + ../README.md modules + ../LICENSE + Indices and tables ==================