From 0e4ea0a67b9b253f9fadf66df7c48f773863b39f Mon Sep 17 00:00:00 2001 From: yusuke-takase Date: Tue, 30 Apr 2024 01:32:22 +0900 Subject: [PATCH] add docs --- docs/Makefile | 7 +++++-- docs/{source => }/conf.py | 0 docs/{source => }/grasp2alm.rst | 0 docs/{source => }/index.rst | 2 +- docs/make.bat | 8 ++++++-- docs/{source => }/modules.rst | 0 6 files changed, 12 insertions(+), 5 deletions(-) rename docs/{source => }/conf.py (100%) rename docs/{source => }/grasp2alm.rst (100%) rename docs/{source => }/index.rst (88%) rename docs/{source => }/modules.rst (100%) diff --git a/docs/Makefile b/docs/Makefile index d0c3cbf..4d383bc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,8 +5,8 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build +SOURCEDIR = . +BUILDDIR = _build # Put it first so that "make" without argument is like "make help". help: @@ -18,3 +18,6 @@ help: # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). %: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +html: Makefile + @$(SPHINXBUILD) -b html "$(SOURCEDIR)" "docs" $(SPHINXOPTS) $(O) diff --git a/docs/source/conf.py b/docs/conf.py similarity index 100% rename from docs/source/conf.py rename to docs/conf.py diff --git a/docs/source/grasp2alm.rst b/docs/grasp2alm.rst similarity index 100% rename from docs/source/grasp2alm.rst rename to docs/grasp2alm.rst diff --git a/docs/source/index.rst b/docs/index.rst similarity index 88% rename from docs/source/index.rst rename to docs/index.rst index c44ef34..8ed69b1 100644 --- a/docs/source/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ .. grasp2alm documentation master file, created by - sphinx-quickstart on Tue Apr 30 00:47:56 2024. + sphinx-quickstart on Tue Apr 30 01:10:39 2024. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/docs/make.bat b/docs/make.bat index 747ffb7..a58b12a 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -7,8 +7,8 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=source -set BUILDDIR=build +set SOURCEDIR=. +set BUILDDIR=_build %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 ( @@ -23,6 +23,10 @@ if errorlevel 9009 ( exit /b 1 ) +:html +%SPHINXBUILD% -b html %SOURCEDIR% "docs" %SPHINXOPTS% %O% +goto end + if "%1" == "" goto help %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% diff --git a/docs/source/modules.rst b/docs/modules.rst similarity index 100% rename from docs/source/modules.rst rename to docs/modules.rst