add readme and docker build (#81)

This commit is contained in:
Adil Hafeez 2024-09-25 10:05:59 -07:00 committed by GitHub
parent 43d6bc80e9
commit 425a080c96
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 18 additions and 60 deletions

6
docs/Dockerfile Normal file
View file

@ -0,0 +1,6 @@
FROM sphinxdoc/sphinx
WORKDIR /docs
ADD requirements.txt /docs
RUN python3 -m pip install -r requirements.txt
RUN pip freeze

8
docs/README.md Normal file
View file

@ -0,0 +1,8 @@
## Generate HTML from reStructuredText files
To generate docs execute following command,
```sh
sh build_docs.sh
```
## Requirements
This build system requires [docker](https://docs.docker.com/engine/install/) to be intsalled and running locally.

2
docs/build_docs.sh Normal file
View file

@ -0,0 +1,2 @@
docker build -f Dockerfile . -t sphinx
docker run --rm -v ./:/docs sphinx make html

View file

@ -1,35 +0,0 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
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

View file

@ -1,25 +1,2 @@
alabaster==0.7.16
babel==2.16.0
certifi==2024.8.30
charset-normalizer==3.3.2
docutils==0.20.1
idna==3.10
imagesize==1.4.1
Jinja2==3.1.4
MarkupSafe==2.1.5
packaging==24.1
Pygments==2.18.0
requests==2.32.3
snowballstemmer==2.2.0
Sphinx==7.4.7
sphinx-copybutton==0.5.2
sphinx-rtd-theme==2.0.0
sphinxcontrib-applehelp==2.0.0
sphinxcontrib-devhelp==2.0.0
sphinxcontrib-htmlhelp==2.1.0
sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==2.0.0
sphinxcontrib-serializinghtml==2.0.0
urllib3==2.2.3
sphinx_book_theme
sphinx_book_theme==1.1.3
sphinx_copybutton==0.5.2