This commit is contained in:
2023-12-26 16:55:02 -05:00
commit 71329d5484
32 changed files with 1248 additions and 0 deletions

5
Docs/.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
# Dev
Pipfile*
# Build
_build

17
Docs/Makefile Normal file
View File

@@ -0,0 +1,17 @@
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
# Refactored from minimal makefile
all: latexpdf
clean:
git clean -fdX
latexpdf: Makefile
@$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
html: Makefile
@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

21
Docs/README.md Normal file
View File

@@ -0,0 +1,21 @@
# Building the Docs
To get started, you'll need a few things, you should have `pipenv`
(or your favorite python container tool). And some familiarly with RST.
To begin, install the requirements into your python environment
```
pipenv install -r requirements.txt
pipenv shell
```
To make things easier, this project uses a build tool called make
To use it just run
```
make
```
Thats it! Make some edits, and then run `make html`

57
Docs/conf.py Normal file
View File

@@ -0,0 +1,57 @@
import os
import sys
import subprocess
import sphinx_theme
# Revision/git information
try:
release = (
subprocess.check_output(
[
"git",
"describe",
"--abbrev=4",
"--always",
"--tags",
]
)
.strip()
.decode("utf-8")
)
except subprocess.CalledProcessError:
release = "NotARepo"
# Project Information
project = "InstrumentVisor"
copyright = "2023, Joe"
author = "Joe"
# General Config
extensions = [
"sphinx.ext.autosectionlabel",
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
# HTML output options
html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
# PDF output options
latex_elements = {"extraclassoptions": "openany,oneside"}
latex_logo = "resources/logo.png"

9
Docs/index.rst Normal file
View File

@@ -0,0 +1,9 @@
InstrumentVisor Docs
===============================
.. toctree::
:maxdepth: 3
:caption: Contents:
introduction/introduction

View File

@@ -0,0 +1,7 @@
Introduction
############
Welcome!
========
Put an introduction here!

5
Docs/requirements.txt Normal file
View File

@@ -0,0 +1,5 @@
# Sphinx
sphinx
sphinx-theme
sphinx-rtd-theme
readthedocs-sphinx-search

BIN
Docs/resources/logo.kra Normal file

Binary file not shown.

BIN
Docs/resources/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB