diff options
| author | Ben McGinnes <[email protected]> | 2018-12-04 22:17:31 +0000 |
|---|---|---|
| committer | Ben McGinnes <[email protected]> | 2018-12-04 22:17:31 +0000 |
| commit | 6d8823b81162c18406d40ec59bd252cfdf1df648 (patch) | |
| tree | 9a05b7a38e66dac7301c764b9df240178a35e862 /lang/python/doc/rst/make.bat | |
| parent | Merge branch 'master' of ssh+git://playfair.gnupg.org/git/gpgme (diff) | |
| download | gpgme-6d8823b81162c18406d40ec59bd252cfdf1df648.tar.gz gpgme-6d8823b81162c18406d40ec59bd252cfdf1df648.zip | |
python: Sphinx support
* Added framework from sphinx-quickstart to lang/python/doc/rst/ so
that Python developers already using Sphinx can use the generated
reST files with existing documentation systems.
* Note that when generating source files from Org-mode, the index page
will require manual intervention to match the Sphinx requirements.
Signed-off-by: Ben McGinnes <[email protected]>
Diffstat (limited to 'lang/python/doc/rst/make.bat')
| -rw-r--r-- | lang/python/doc/rst/make.bat | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/lang/python/doc/rst/make.bat b/lang/python/doc/rst/make.bat new file mode 100644 index 00000000..27f573b8 --- /dev/null +++ b/lang/python/doc/rst/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%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
|