-
Notifications
You must be signed in to change notification settings - Fork 0
/
.readthedocs.yaml
54 lines (52 loc) · 3.79 KB
/
.readthedocs.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# -*- coding: utf-8 -*-
# ########################################################################
# Program: Luminal
# Author: Jason Drawdy
# Version: 1.0.0
# Date: 07/26/23
# #########################################################################
# Description:
# Contains all configuration details for uploading Luminal documentation.
# #########################################################################
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# #########################################################################
version: 2 #? Required
formats: all
# Set the OS, Python version and other tools you might need.
build:
os: ubuntu-22.04
tools:
python: "3.11"
commands:
- mkdir --parents _readthedocs/html/
- cp --recursive docs/_build/* _readthedocs/html/
#! I'm building documentation locally because building remote is difficult to get everything precise.
#! To actually build it yourself just `cd docs` and then run `sphinx-build -b html . _build`
#* ─────────────────────────────────
#* ────────▄███▄───────▄███▄────────
#* ───────███████─────███████───────
#* ──────█████████───█████████──────
#* ────▄███████████─███████████▄────
#* ──▄█████████████─█████████████▄──
#* ▄███████████████─███████████████▄
#* ████████████████─████████████████
#* ████████████████─████████████████
#* ▀███████████████████████████████▀
#* ──▀███████████████████████████▀──
#* ────▀███████████████████████▀────
#* ──────────▀███████████▀──────────
#* ────▄████████████████████████▄───
#* ─▄█████████████████████████████▄─
#* █████████████████████████████████
#* █████████████████████████████████
#* ███████████████─██─██████████████
#* ███████████████─██─██████████████
#* ─██████████████─██─████████████▀─
#* ──▀████████████─██─██████████▀───
#* ────▀█████████──██──████████▀────
#* ──────███████───██───██████▀─────
#* ───────▀███▀────███───▀███▀──────
#* ─────────────────███─────────────
#* ──────────────────███────────────
#* ───────────────────███───────────