diff --git a/.gitignore b/.gitignore index ea4e3f2..a5c14e5 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ Pipfile.lock __pycache__/ .venv* *.py[o|c] +**_build/ diff --git a/Makefile b/Makefile index dfd4489..7d827f3 100644 --- a/Makefile +++ b/Makefile @@ -21,4 +21,7 @@ requirements: pipenv requirements > requirements.txt pipenv requirements --dev-only > requirements_dev.txt - +docs: + cd docs/ && make html + cd docs && firefox ./_build/html/index.html & +.PHONY: docs diff --git a/Pipfile b/Pipfile index d3a82e4..a58cd5b 100644 --- a/Pipfile +++ b/Pipfile @@ -7,6 +7,8 @@ name = "pypi" [dev-packages] pytest = "*" +sphinx = "==7.1.2" +"sphinx.builders.linkcheck" = "*" [requires] python_version = "3.12" diff --git a/README.rst b/README.rst index a9b375f..b18ac90 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,6 @@ -########### +################################### Documentation the movie API project -########### +################################### ******** Context @@ -23,17 +23,17 @@ We assume make is installed if pipenv is installed: -.. code block:: shell +.. code-block:: shell - make clean install run_dev + make clean install run_dev if pipenv is *not* installed -.. code block:: shell +.. code-block:: shell - make -f MakefileVenv clean install run_dev + make -f MakefileVenv clean install run_dev diff --git a/dev.py b/dev.py new file mode 100644 index 0000000..894eaff --- /dev/null +++ b/dev.py @@ -0,0 +1,2 @@ +if __name__ == "__main__": + print("dev.py file ok") diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d4bb2cb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/README.rst b/docs/README.rst new file mode 120000 index 0000000..89a0106 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1 @@ +../README.rst \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..c1902fd --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,27 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Movie Api' +copyright = '2023, Colin Goutte' +author = 'Colin Goutte' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'alabaster' +html_static_path = ['_static'] diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..3d9b44f --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,21 @@ +.. Movie Api documentation master file, created by + sphinx-quickstart on Wed Aug 23 17:08:08 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Movie Api's documentation! +===================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + ./README.rst + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..32bb245 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@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