From 3db30b12d66354743d08d1bdae95e2e649785017 Mon Sep 17 00:00:00 2001 From: Natsu Tadama Date: Mon, 7 Aug 2023 23:47:35 +0700 Subject: [PATCH] Add index, makefiles, and mark as vendored --- .gitattributes | 2 ++ docs/Makefile | 20 ++++++++++++++++++++ docs/index.rst | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++ docs/make.bat | 35 ++++++++++++++++++++++++++++++++++ 4 files changed, 108 insertions(+) create mode 100644 .gitattributes create mode 100644 docs/Makefile create mode 100644 docs/index.rst create mode 100644 docs/make.bat diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1cd4bb8 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +Makefile linguist-vendored +make.bat linguist-vendored diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..41c270b --- /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) \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..ae168e1 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,51 @@ +AnimeAPI Reference Docs +======================= + +AnimeAPI +-------- + +.. autoclass:: animeapi.AnimeAPI + :members: + + .. automethod:: __init__ + + +AsyncAnimeAPI +------------- + +.. autoclass:: animeapi.AsyncAnimeAPI + :members: + + .. automethod:: __init__ + + +Models +------ + +.. automodule:: animeapi.models + :members: + + .. automethod:: __init__ + + +Exceptions +---------- + +.. automodule:: animeapi.exceptions + :members: + + .. automethod:: __init__ + +.. toctree:: + :hidden: + + index + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..96ed709 --- /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 + +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 \ No newline at end of file