Skip to content

Commit

Permalink
chore: add github workflows for linkcheck
Browse files Browse the repository at this point in the history
chore: add changes for new rtd build process
  • Loading branch information
redteampanda-ng committed Jul 18, 2024
1 parent 29298f2 commit 39576d6
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .github/workflows/pre-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

name: Manual Pre Checks

on:
push:
branches:
- "*"
pull_request:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
linkcheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: link-check
run: |
pip install -r requirements.txt
make linkcheck
9 changes: 8 additions & 1 deletion conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import os

project = 'THOR Cloud Microsoft Defender for Endpoint'
version="1.0"
copyright = '2021, Nextron Systems GmbH'
author = 'Nextron Systems GmbH'
extensions = [
'sphinx.ext.autosectionlabel',
'sphinx_rtd_theme'
]
templates_path = ['_templates']
source_suffix = '.rst'
Expand All @@ -20,6 +21,12 @@
html_favicon = "images/html/favicon.ico"
html_static_path = ['_static']
html_css_files = ['css/custom.css',]
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
if os.environ.get("READTHEDOCS", "") == "True":
if "html_context" not in globals():
html_context = {}
html_context["READTHEDOCS"] = True

epub_title = project
epub_exclude_files = ['search.html']
intersphinx_mapping = {'https://docs.python.org/': None}
Expand Down

0 comments on commit 39576d6

Please sign in to comment.