From 7f1d4062422a60e691c61b5174faaf6728dfaabc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jon=C3=A1=C5=A1=20Havelka?= Date: Mon, 7 Mar 2022 21:56:09 +0100 Subject: [PATCH] =?UTF-8?q?P=C5=99esunut=C3=AD=20apidoc=20z=20conf.py=20do?= =?UTF-8?q?=20Makefilu.=20Fuj=20Windows?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/Makefile | 2 +- docs/conf.py | 4 ---- docs/make.bat | 35 ----------------------------------- docs/sphinx.rst | 4 ---- 4 files changed, 1 insertion(+), 44 deletions(-) delete mode 100644 docs/make.bat diff --git a/docs/Makefile b/docs/Makefile index 61eab5c7..b12affc9 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -17,5 +17,5 @@ help: # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile - #sphinx-apidoc --module-first -o modules .. ../*/migrations --templatedir _templates -f + sphinx-apidoc --module-first -o modules .. ../*/migrations --templatedir _templates -f @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py index 584272c8..24f2bfed 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -79,7 +79,3 @@ autodoc_member_order = "bysource" # Nezobrazování zděděné (ze super tříd) dokumentace TODO nefunguje? autodoc_inherit_docstrings = False - -# Spouštění sphinx-apidoc -from sphinx.ext.apidoc import main -main(['--module-first', '-o', "modules", "..", "../*/migrations", "--templatedir", "_templates", '-f']) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 8084272b..00000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@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.https://www.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/docs/sphinx.rst b/docs/sphinx.rst index 99a92d74..fea2c1a7 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -11,10 +11,6 @@ Sphinx se píše v rst: `Návod na syntaxi rst`_ `Cheat sheet`_ .. _Návod na syntaxi rst: https://sphinx-tutorial.readthedocs.io/step-1/#sections .. _Cheat sheet: https://sphinx-tutorial.readthedocs.io/cheatsheet/ -Problém -------- -U mě ``make html`` vůbec nereagoval na změny ``Makefile``, tedy jsem ``sphinx-apidoc...`` nakódil přímo do ``conf.py``. - make html --------- Make html dělá následující: Vygenerují se rst soubory do modules z pythoní dokumentace pomocí::