Skip to content

Commit 066474f

Browse files
feature: change doc structure to match pgm style
Signed-off-by: jaapschoutenalliander <[email protected]>
1 parent 4889bcf commit 066474f

34 files changed

+63
-11
lines changed

.gitignore

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,6 @@ dist/
4949
# direnv config
5050
.envrc
5151

52-
# docs
53-
docs/build/
54-
docs/make.bat
55-
docs/Makefile
56-
5752
# Generated files
5853
*.egg-info
5954
PYPI_VERSION

docs/Makefile

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <[email protected]>
2+
#
3+
# SPDX-License-Identifier: MPL-2.0
4+
5+
# Minimal makefile for Sphinx documentation
6+
#
7+
8+
# You can set these variables from the command line, and also
9+
# from the environment for the first two.
10+
SPHINXOPTS ?=
11+
SPHINXBUILD ?= sphinx-build
12+
SOURCEDIR = source
13+
BUILDDIR = _build
14+
15+
# Put it first so that "make" without argument is like "make help".
16+
help:
17+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
18+
19+
.PHONY: help Makefile
20+
21+
# Catch-all target: route all unknown targets to Sphinx using the new
22+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
23+
%: Makefile
24+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)