Mirrors/EOS
1
0
Fork 0
mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2025-04-19 08:55:15 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fix docs creation Closes #218 (#219)

Browse Source 
* Fix swagger link in sphynx docs.
This commit is contained in:
Dominique Lasserre 2024-11-23 16:44:46 +01:00 committed by GitHub
parent 5e2eae7331
commit ab4cef4b0b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Makefile
View File

@ -51,6 +51,7 @@ dist: pip
# Target to generate HTML documentation # Target to generate HTML documentation
docs: pip-dev docs: pip-dev
mkdir -p docs/develop
cp README.md docs/develop/getting_started.md cp README.md docs/develop/getting_started.md
# remove top level header and coresponding description # remove top level header and coresponding description
sed -i '/^##[^#]/,$$!d' docs/develop/getting_started.md sed -i '/^##[^#]/,$$!d' docs/develop/getting_started.md

2
docs/akkudoktoreos/serverapi.rst
View File

@ -7,7 +7,7 @@
Server API Server API
########## ##########
For a more detailed documentation see the Swagger interface: `EOS OpenAPI Spec <https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/openapi.json>`_ For a more detailed documentation see the Swagger interface: `EOS OpenAPI Spec <https://petstore3.swagger.io/?url=https://raw.githubusercontent.com/Akkudoktor-EOS/EOS/refs/heads/main/docs/akkudoktoreos/openapi.json>`_
.. openapi:: openapi.json .. openapi:: openapi.json
:examples: :examples: