Commit f5701b55 authored by vertighel's avatar vertighel
Browse files

Test doc

parent f5385fce

.gitignore

+2 −1
Original line number Diff line number Diff line
@@ -81,7 +81,8 @@ instance/ 
.scrapy



# Sphinx documentation

docs/_build/

docs/build/

/public



# PyBuilder

target/

.gitlab-ci.yml

+24 −2
Original line number Diff line number Diff line
@@ -20,6 +20,7 @@ cache: 
stages:

  - setup_and_format 

  - lint # Does not modify code

  - deploy_docs

  - auto_commit



# Job 1: Install ${PROJECT} and its dependencies
@@ -122,6 +123,28 @@ run_pylint: 
  #  - when: manual

  #    allow_failure: true # Allow manual trigger to not fail overall pipeline if desired







# Job 6: Create documentation

# This defines a job named 'pages'. GitLab recognizes this special name

# and knows that its purpose is to deploy a website to GitLab Pages.

pages:

  stage: deploy_docs

  

  # Commands to run before the main script. Perfect for installing dependencies.

  before_script:

    - pip install -r docs/requirements.txt

  script:

    - sphinx-apidoc -o docs/source noctua

    - sphinx-build -b html docs/source public

  artifacts:

    paths:

      - . # Pass the modified workspace

  #    - public

  # rules:

  #   - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH

  

# Job 7: commit in branch

commit_formatted_code:

  stage: auto_commit

  tags:
@@ -148,4 +171,3 @@ commit_formatted_code: 
        - Pipeline ID: $CI_PIPELINE_ID

        - [skip ci]"

    - git push --force https://davide.ricci:$GITLAB_TOKEN@www.ict.inaf.it/gitlab/davide.ricci/software-di-controllo.git ${FORMATTED_BRANCH_NAME}

docs/Makefile

0 → 100644
+20 −0
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     = source

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/make.bat

0 → 100644
+35 −0
Original line number Diff line number Diff line 
@ECHO OFF



pushd %~dp0



REM Command file for Sphinx documentation



if "%SPHINXBUILD%" == "" (

	set SPHINXBUILD=sphinx-build

)

set SOURCEDIR=source

set BUILDDIR=build



%SPHINXBUILD% >NUL 2>NUL

if errorlevel 9009 (

	echo.

	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx

	echo.installed, then set the SPHINXBUILD environment variable to point

	echo.to the full path of the 'sphinx-build' executable. Alternatively you

	echo.may add the Sphinx directory to PATH.

	echo.

	echo.If you don't have Sphinx installed, grab it from

	echo.https://www.sphinx-doc.org/

	exit /b 1

)



if "%1" == "" goto help



%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%

goto end



:help

%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%



:end

popd

docs/requirements.txt

0 → 100644
+2 −0
Original line number Diff line number Diff line 
sphinx

sphinx_rtd_theme