mam/mamweb
13
1
Fork 0
Code Issues Pull requests 12 Projects Wiki Activity Actions

Přesunutí apidoc z conf.py do Makefilu. Fuj Windows

Browse source
This commit is contained in:
Jonas Havelka 2022-03-07 21:56:09 +01:00
parent 5113a7adab
commit 7f1d406242
4 changed files with 1 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/Makefile
View file

@ -17,5 +17,5 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new # Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile %: 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) @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

4
docs/conf.py
View file

@ -79,7 +79,3 @@ autodoc_member_order = "bysource"
# Nezobrazování zděděné (ze super tříd) dokumentace TODO nefunguje? # Nezobrazování zděděné (ze super tříd) dokumentace TODO nefunguje?
autodoc_inherit_docstrings = False autodoc_inherit_docstrings = False
# Spouštění sphinx-apidoc
from sphinx.ext.apidoc import main
main(['--module-first', '-o', "modules", "..", "../*/migrations", "--templatedir", "_templates", '-f'])

35
docs/make.bat
View file

@ -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

4
docs/sphinx.rst
View file

@ -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 .. _Návod na syntaxi rst: https://sphinx-tutorial.readthedocs.io/step-1/#sections
.. _Cheat sheet: https://sphinx-tutorial.readthedocs.io/cheatsheet/ .. _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
--------- ---------
Make html dělá následující: Vygenerují se rst soubory do modules z pythoní dokumentace pomocí:: Make html dělá následující: Vygenerují se rst soubory do modules z pythoní dokumentace pomocí::