Skip to content
Snippets Groups Projects
Commit 4b7c67ea authored by Hannes Feldt's avatar Hannes Feldt
Browse files

Fix docs

parent 2d1ffc66
No related branches found
No related tags found
1 merge request!27Fix docs
Pipeline #65309 failed
Pipeline: Python Package

#65310

    This commit is part of merge request !27. Comments created here will be created in the context of that merge request.
    ...@@ -11,6 +11,7 @@ dist ...@@ -11,6 +11,7 @@ dist
    # Documentation # Documentation
    docs/source/source_documentation docs/source/source_documentation
    !docs/source/source_documentation/index.rst
    docs/build docs/build
    # Setuptools SCM # Setuptools SCM
    ......
    #!/usr/bin/env python3
    # Copyright (C) 2023 ASTRON (Netherlands Institute for Radio Astronomy)
    # SPDX-License-Identifier: Apache-2.0
    import os
    file_dir = os.path.dirname(os.path.realpath(__file__))
    clean_dir = os.path.join(file_dir, "source", "source/source_documentation")
    print(f"Cleaning.. {clean_dir}/*")
    for file_name in os.listdir(clean_dir):
    file = os.path.join(clean_dir, file_name)
    match file_name:
    case "index.rst": continue
    case _:
    print(f"Removing.. {file}")
    os.remove(file)
    #!/bin/sh
    FILE_DIR=$(dirname -- "$(readlink -f -- "${0}")")
    echo "Cleaning.. ${FILE_DIR}/source/source_documentation/*"
    for f in "${FILE_DIR}"/source/source_documentation/*
    do
    case $f in
    */index.rst) true;;
    *) echo "Removing.. ${f}"; rm "${f}";;
    esac
    done
    ...@@ -41,8 +41,6 @@ commands = ...@@ -41,8 +41,6 @@ commands =
    format: {envpython} -m black -v {{cookiecutter.project_slug}} tests format: {envpython} -m black -v {{cookiecutter.project_slug}} tests
    [testenv:docs] [testenv:docs]
    allowlist_externals =
    sh
    ; unset LC_ALL / LANGUAGE from testenv, would fail sphinx otherwise ; unset LC_ALL / LANGUAGE from testenv, would fail sphinx otherwise
    setenv = setenv =
    deps = deps =
    ...@@ -50,7 +48,7 @@ deps = ...@@ -50,7 +48,7 @@ deps =
    -r{toxinidir}/docs/requirements.txt -r{toxinidir}/docs/requirements.txt
    changedir = {toxinidir} changedir = {toxinidir}
    commands = commands =
    sh docs/cleanup.sh {envpython} docs/cleanup.py
    sphinx-build -b html docs/source docs/build/html sphinx-build -b html docs/source docs/build/html
    [testenv:build] [testenv:build]
    ......
    0% Loading or .
    You are about to add 0 people to the discussion. Proceed with caution.
    Please register or to comment