Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yusuke-takase committed Apr 29, 2024
1 parent 20fdc81 commit 0e4ea0a
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 5 deletions.
7 changes: 5 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/source/index.rst → docs/index.rst
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 6 additions & 2 deletions docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand All @@ -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%
Expand Down
File renamed without changes.

0 comments on commit 0e4ea0a

Please sign in to comment.