From 05168bdd80bd5cb5056a6101517ae626197439a0 Mon Sep 17 00:00:00 2001 From: Lukas Tenbrink Date: Tue, 29 Jul 2025 19:58:55 +0200 Subject: [PATCH] Adjust and simplify template. --- .gitignore | 3 + .readthedocs.yaml | 4 +- docs/Makefile => Makefile | 2 +- README.md | 19 ++++++ README.rst | 9 --- docs/source/conf.py => conf.py | 6 +- docs/source/api.rst | 7 --- docs/source/index.rst | 22 ------- docs/source/usage.rst | 34 ----------- index.rst | 2 + lumache.py | 23 -------- docs/make.bat => make.bat | 70 +++++++++++------------ pyproject.toml | 2 +- docs/requirements.txt => requirements.txt | 0 14 files changed, 66 insertions(+), 137 deletions(-) rename docs/Makefile => Makefile (96%) create mode 100644 README.md delete mode 100644 README.rst rename docs/source/conf.py => conf.py (84%) delete mode 100644 docs/source/api.rst delete mode 100644 docs/source/index.rst delete mode 100644 docs/source/usage.rst create mode 100644 index.rst delete mode 100644 lumache.py rename docs/make.bat => make.bat (92%) rename docs/requirements.txt => requirements.txt (100%) diff --git a/.gitignore b/.gitignore index a9b7dc7..106c233 100644 --- a/.gitignore +++ b/.gitignore @@ -154,3 +154,6 @@ dmypy.json cython_debug/ # End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks + +# IDEs +.idea/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9138a7f..4add0d8 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -7,7 +7,7 @@ build: python: install: - - requirements: docs/requirements.txt + - requirements: requirements.txt sphinx: - configuration: docs/source/conf.py + configuration: conf.py diff --git a/docs/Makefile b/Makefile similarity index 96% rename from docs/Makefile rename to Makefile index d0c3cbf..ed88099 100644 --- a/docs/Makefile +++ b/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = source +SOURCEDIR = . BUILDDIR = build # Put it first so that "make" without argument is like "make help". diff --git a/README.md b/README.md new file mode 100644 index 0000000..841fc60 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# Godot Engine Contributing documentation + +WIP Repository + +## Setup + +```bash +python -m venv .venv +source .venv/bin/activate +pip install +``` + +## Serve + +```bash +make html +cd build/html +python -m http.server +``` diff --git a/README.rst b/README.rst deleted file mode 100644 index 07eac7f..0000000 --- a/README.rst +++ /dev/null @@ -1,9 +0,0 @@ -Template for the Read the Docs tutorial -======================================= - -This GitHub template includes fictional Python library -with some basic Sphinx docs. - -Read the tutorial here: - -https://docs.readthedocs.io/en/stable/tutorial/ diff --git a/docs/source/conf.py b/conf.py similarity index 84% rename from docs/source/conf.py rename to conf.py index 6e9e8c0..6f10251 100644 --- a/docs/source/conf.py +++ b/conf.py @@ -2,9 +2,9 @@ # -- Project information -project = 'Lumache' -copyright = '2021, Graziella' -author = 'Graziella' +project = 'Godot Contributing Docs' +copyright = '2025, Godot Engine Contributors' +author = 'Godot Engine Contributors' release = '0.1' version = '0.1.0' diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index ec94338..0000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,7 +0,0 @@ -API -=== - -.. autosummary:: - :toctree: generated - - lumache diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index 03d09a5..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,22 +0,0 @@ -Welcome to Lumache's documentation! -=================================== - -**Lumache** (/lu'make/) is a Python library for cooks and food lovers -that creates recipes mixing random ingredients. -It pulls data from the `Open Food Facts database `_ -and offers a *simple* and *intuitive* API. - -Check out the :doc:`usage` section for further information, including -how to :ref:`installation` the project. - -.. note:: - - This project is under active development. - -Contents --------- - -.. toctree:: - - usage - api diff --git a/docs/source/usage.rst b/docs/source/usage.rst deleted file mode 100644 index 924afcf..0000000 --- a/docs/source/usage.rst +++ /dev/null @@ -1,34 +0,0 @@ -Usage -===== - -.. _installation: - -Installation ------------- - -To use Lumache, first install it using pip: - -.. code-block:: console - - (.venv) $ pip install lumache - -Creating recipes ----------------- - -To retrieve a list of random ingredients, -you can use the ``lumache.get_random_ingredients()`` function: - -.. autofunction:: lumache.get_random_ingredients - -The ``kind`` parameter should be either ``"meat"``, ``"fish"``, -or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients` -will raise an exception. - -.. autoexception:: lumache.InvalidKindError - -For example: - ->>> import lumache ->>> lumache.get_random_ingredients() -['shells', 'gorgonzola', 'parsley'] - diff --git a/index.rst b/index.rst new file mode 100644 index 0000000..95bb3ee --- /dev/null +++ b/index.rst @@ -0,0 +1,2 @@ +WIP +=== diff --git a/lumache.py b/lumache.py deleted file mode 100644 index 3ea7ce9..0000000 --- a/lumache.py +++ /dev/null @@ -1,23 +0,0 @@ -""" -Lumache - Python library for cooks and food lovers. -""" - -__version__ = "0.1.0" - - -class InvalidKindError(Exception): - """Raised if the kind is invalid.""" - pass - - -def get_random_ingredients(kind=None): - """ - Return a list of random ingredients as strings. - - :param kind: Optional "kind" of ingredients. - :type kind: list[str] or None - :raise lumache.InvalidKindError: If the kind is invalid. - :return: The ingredients list. - :rtype: list[str] - """ - return ["shells", "gorgonzola", "parsley"] diff --git a/docs/make.bat b/make.bat similarity index 92% rename from docs/make.bat rename to make.bat index 6247f7e..3d64bb3 100644 --- a/docs/make.bat +++ b/make.bat @@ -1,35 +1,35 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%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.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=build + +if "%1" == "" goto help + +%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.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/pyproject.toml b/pyproject.toml index 14a2dda..bd5eac8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,6 +3,6 @@ requires = ["flit_core >=3.2,<4"] build-backend = "flit_core.buildapi" [project] -name = "lumache" +name = "Godot Contributing Docs" authors = [{name = "Graziella", email = "graziella@lumache"}] dynamic = ["version", "description"] diff --git a/docs/requirements.txt b/requirements.txt similarity index 100% rename from docs/requirements.txt rename to requirements.txt