Unverified Commit afa0da9d authored by Akke Viitanen's avatar Akke Viitanen
Browse files

update documentation

parent efe2a16d

.gitlab-ci.yml

+1 −1
Original line number Diff line number Diff line
@@ -23,7 +23,7 @@ pages: 
    - python3 -m ipykernel install --user

    - cd docs

    - make html

    - mv ../_readthedocs/html ../public

    - mv build/html ../public

  artifacts:

    paths:

      - public

.readthedocs.yml

deleted100644 → 0
+0 −23
Original line number Diff line number Diff line 


# .readthedocs.yml

# Read the Docs configuration file

# See  https://docs.readthedocs.io/en/stable/config-file/v2.html for details



# Required

version: 2



build:

  os: ubuntu-22.04

  tools:

    python: "3.11"



# Build documentation in the docs/ directory with Sphinx

sphinx:

   configuration: docs/conf.py



# Optionally declare the Python requirements required to build your docs

python:

   install:

   - requirements: docs/requirements.txt

   - method: pip

     path: .

docs/Makefile

+1 −2
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ SPHINXOPTS ?= -T -E -d _build/doctrees -D language=en 
EXCLUDENB     ?= -D exclude_patterns="notebooks/*","_build","**.ipynb_checkpoints"

SPHINXBUILD   ?= sphinx-build

SOURCEDIR     = .

BUILDDIR      = ../_readthedocs/

BUILDDIR      = build



.PHONY: help clean Makefile no-nb no-notebooks
@@ -28,4 +28,3 @@ clean: 
# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

%: Makefile

	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/index.rst

+1 −1
Original line number Diff line number Diff line
@@ -57,4 +57,4 @@ Useful resources 
   install

   userguide

   notebooks

   autoapi
 
   autoapi/index

pyproject.toml

+2 −1
Original line number Diff line number Diff line
@@ -41,7 +41,8 @@ dependencies = [ 
]



[project.urls]

"Source Code" = "https://github.com/ageliina/lsst_inaf_agile"

#"Source Code" = "https://github.com/ageliina/lsst_inaf_agile"

"Source Code" = "https://www.ict.inaf.it/gitlab/akke.viitanen/lsst_inaf_agile"



# On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes)

[project.optional-dependencies]