chores: better folder naming for the sphinx documentation

Author: t-graf

.github/workflows/deploy-documentation.yml

@@ -27,14 +27,12 @@ jobs:
       - name: Build documentation
         run: |
           # use sphinx to build the documentation
-          # 
-          #/home/runner/.local/bin/sphinx-build -b html ./docs/source ./docs/build
-          sphinx-build -b html ./docs ./build
+          sphinx-build -b html ./docs-source ./docs
         
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@4.1.3
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH: gh-pages # The branch the action should deploy to.
-          FOLDER: ./build # The folder the action should deploy.
+          FOLDER: ./docs # The folder the action should deploy.
           CLEAN: true # Automatically remove deleted files from the deploy branch

.gitignore

@@ -1,6 +1,6 @@
 .vscode/
 __pycache__
-build/
+docs/
 dist/
 html/
 

Readme.md

@@ -9,6 +9,11 @@
 This Python project implements the REST API of [SW360](https://www.eclipse.org/sw360/)
 and allows an easy way to interact with SW360.
 
+## Documentation
+
+Have a look at the documentation: https://sw360.github.io/sw360python/
+
+
 ## Usage
 
 ### Installation
@@ -48,7 +53,7 @@ Install fossology and required dependencies:
 The documentation of the project is built using Sphinx:
 
 ```python
-poetry run sphinx-build .\docs build\
+poetry run sphinx-build .\docs-source\ .\docs\
 ```
 
 #### Building Python package