admin/scribe
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

fixed Readme

Browse Source
This commit is contained in:
Jaikinator
2023-10-16 16:20:56 +02:00
parent 87da03d74e
commit 3647753a50
2 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/documentation.yml
+3
View File
@@ -26,6 +26,9 @@ jobs:
- name: Sphinx build - name: Sphinx build
run: | run: |
cp README.md ./source/README.md
cp LICENSE ./source/LICENSE
cp Pictures ./source/Pictures
sphinx-apidoc -o source scraibe/ sphinx-apidoc -o source scraibe/
sphinx-build -M html source docs sphinx-build -M html source docs
make html make html
source/index.rst
+4 -7
View File
@@ -1,22 +1,19 @@
Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligence Based Environment's documentation! Welcome to ScrAIbe: Streamlined Conversation Recording with Automated Intelligence Based Environment's documentation!
===================================================================================================================== =====================================================================================================================
Readme File
===========
.. automodule:: scraibe .. automodule:: scraibe
:members: :members:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
.. include:: ../README.md ../README.md
:parser: myst_parser.sphinx_
modules modules
../LICENSE
Indices and tables Indices and tables
================== ==================