Skip to content
Snippets Groups Projects
Verified Commit 78b88f6c authored by Timm Fitschen's avatar Timm Fitschen
Browse files

WIP: generate docs

parent 86e98459
No related branches found
No related tags found
No related merge requests found
Pipeline #10305 failed
FROM debian:buster FROM debian:buster-backports
RUN apt-get update \
&& \ RUN apt-get update
apt-get install -y \ RUN apt-get install -y make
make \ RUN apt-get install -y octave/buster-backports
octave \ RUN apt-get install -y liboctave-dev
python3-pip \ RUN apt-get install -y python3-pip
python3-sphinx \ RUN apt-get install -y unzip
unzip \ RUN apt-get install -y wget
wget
# install generate-doc package for octave
RUN pip3 install breathe miss_hit sphinx-rtd-theme recommonmark
RUN wget --output-document generate_doc_unreleased.zip \ RUN wget --output-document generate_doc_unreleased.zip \
https://github.com/gnu-octave/generate_doc/archive/refs/heads/main.zip https://github.com/gnu-octave/generate_doc/archive/refs/heads/main.zip
RUN octave --eval "pkg install generate_doc_unreleased.zip" RUN octave --eval "pkg install generate_doc_unreleased.zip"
COPY doc/requirements.txt doc-requirements.txt
RUN pip3 install -r doc-requirements.txt
COPY dev-requirements.txt dev-requirements.txt
RUN pip3 install -r dev-requirements.txt
...@@ -37,9 +37,6 @@ build-testenv: ...@@ -37,9 +37,6 @@ build-testenv:
tags: [ cached-dind ] tags: [ cached-dind ]
stage: setup stage: setup
image: docker:20.10 image: docker:20.10
only:
- schedules
- f-package-docs
script: script:
- cd .docker - cd .docker
- docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY
...@@ -57,7 +54,7 @@ code_style: ...@@ -57,7 +54,7 @@ code_style:
tags: [ docker ] tags: [ docker ]
stage: test stage: test
script: script:
- mh_style --octave src pkg doc - mh_style --octave ./
allow_failure: true allow_failure: true
# Unit tests # Unit tests
...@@ -67,6 +64,12 @@ test: ...@@ -67,6 +64,12 @@ test:
script: script:
- make test - make test
linting:
tags: [ docker ]
stage: test
script:
- mh_lint --octave ./
# Build the sphinx documentation and make it ready for deployment by Gitlab Pages # Build the sphinx documentation and make it ready for deployment by Gitlab Pages
# Special job for serving a static website. See https://docs.gitlab.com/ee/ci/yaml/README.html#pages # Special job for serving a static website. See https://docs.gitlab.com/ee/ci/yaml/README.html#pages
......
miss-hit==0.9.23
miss-hit-core==0.9.23
...@@ -44,9 +44,6 @@ release = '0.1.0' ...@@ -44,9 +44,6 @@ release = '0.1.0'
# ones. # ones.
extensions = [ extensions = [
'sphinx.ext.autosectionlabel', 'sphinx.ext.autosectionlabel',
'sphinx.ext.intersphinx',
'sphinx.ext.napoleon', # For Google style docstrings
"recommonmark", # For markdown files.
"sphinx_rtd_theme", "sphinx_rtd_theme",
] ]
...@@ -116,13 +113,3 @@ htmlhelp_basename = 'caosdb-octavelibdoc' ...@@ -116,13 +113,3 @@ htmlhelp_basename = 'caosdb-octavelibdoc'
# -- Extension configuration ------------------------------------------------- # -- Extension configuration -------------------------------------------------
# -- Options for intersphinx -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_mapping
intersphinx_mapping = {
"python": ("https://docs.python.org/", None),
"caosdb-mysqlbackend": ("https://caosdb.gitlab.io/caosdb-mysqlbackend/",
None),
"caosdb-server": ("https://caosdb.gitlab.io/caosdb-server/", None),
}
alabaster==0.7.12
Babel==2.9.1
certifi==2021.5.30
charset-normalizer==2.0.1
docutils==0.16
idna==3.2
imagesize==1.2.0
Jinja2==3.0.1
MarkupSafe==2.0.1
packaging==21.0
Pygments==2.9.0
pyparsing==2.4.7
pytz==2021.1
requests==2.26.0
snowballstemmer==2.1.0
Sphinx==4.1.0
sphinx-rtd-theme==0.5.2
sphinxcontrib-applehelp==1.0.2
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.3
sphinxcontrib-serializinghtml==1.1.5
urllib3==1.26.6
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment