cara/caimira/docs/sphinx/make.bat
Nicola Tarocco a34efcac88 Project documentation and CI/CD improvements:
- Added docs folder with MkDocs and Sphinx integration for documentation.
- Updated GitLab CI/CD configuration to include documentation jobs.
- Improved Dockerfile for streamlined builds.
- Added JavaScript file to support MathJax for equations in MkDocs.
- Created and included a UML diagram for architectural overview.
- Removed unused files to clean up the repository.
- Updated project and package README files for consistency.
- Revised diameter-dependent documentation for clarity.
- Added detailed REST API documentation.
- Updated project version for release tracking.
- Included open-source acknowledgments in the documentation.
- Added repository details and UI instructions to the user guide.
- Integrated CO2 fitting algorithm into the project.
- Included logo on the main documentation page and added CI/CD prod job.
2024-11-20 15:23:46 +01:00

35 lines
800 B
Batchfile

@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
%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.https://www.sphinx-doc.org/
exit /b 1
)
if "%1" == "" goto help
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd