Commit b007cb8f authored by Asitha Senanayake's avatar Asitha Senanayake
Browse files

Merge branch 'main' into 'main'

Update docs to mkdocs

See merge request !59
parents 08faba25 1df97d41
Loading
Loading
Loading
Loading
Loading
+12 −7
Original line number Diff line number Diff line
@@ -22,16 +22,21 @@ build-linux:
  tags:
    - linux


# Create docs
image: python:3.8-buster

before_script:
  - pip install mkdocs
  - pip install mkdocs-material
  - pip install mkdocstrings[python]
pages:
  stage: deploy_html_docs
  image: python:3.10
  script:
  - pip install -U sphinx sphinx-rtd-theme
  - cd docs
  - sphinx-build -b html . ../public
  - cp custom.css ../public/_static/custom.css # Custom CSS file to increase width of html pages
  - mkdocs build
  - mv site public
  artifacts:
    paths:
    - public
  rules:
    - if: $CI_COMMIT_REF_NAME == $CI_DEFAULT_BRANCH
  only:
  - main

docs/Makefile

deleted100644 → 0
+0 −20
Original line number Diff line number Diff line
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS    ?=
SPHINXBUILD   ?= sphinx-build
SOURCEDIR     = .
BUILDDIR      = _build

# Put it first so that "make" without argument is like "make help".
help:
	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/ags4.md

0 → 100644
+1 −0
Original line number Diff line number Diff line
::: python_ags4.AGS4
 No newline at end of file

docs/ags4_cli.md

0 → 100644
+1 −0
Original line number Diff line number Diff line
::: python_ags4.ags4_cli
 No newline at end of file

docs/check.md

0 → 100644
+1 −0
Original line number Diff line number Diff line
::: python_ags4.check
 No newline at end of file
Loading