Compare commits
No commits in common. "c9be127836c5cf613b5613138dfbebbb473e1300" and "3619601efaf242d9df99922894082d8cd6d79af9" have entirely different histories.
c9be127836
...
3619601efa
3
.gitignore
vendored
3
.gitignore
vendored
@ -3,6 +3,3 @@ bin/*
|
|||||||
.pio
|
.pio
|
||||||
*.swp
|
*.swp
|
||||||
Pipfile.lock
|
Pipfile.lock
|
||||||
html
|
|
||||||
latex
|
|
||||||
xml
|
|
||||||
|
@ -17,7 +17,3 @@ pipeline:
|
|||||||
image: python
|
image: python
|
||||||
- pip install -U platformio
|
- pip install -U platformio
|
||||||
- pio check -e esp8266 -e esp32 --skip-packages --severity medium --severity high --pattern 'src' --pattern 'lib/Figments' --fail-on-defect high
|
- pio check -e esp8266 -e esp32 --skip-packages --severity medium --severity high --pattern 'src' --pattern 'lib/Figments' --fail-on-defect high
|
||||||
docs:
|
|
||||||
image: python
|
|
||||||
- pip install -U breathe sphinx
|
|
||||||
- cd docs && sphinx
|
|
||||||
|
@ -2094,7 +2094,7 @@ MAN_LINKS = NO
|
|||||||
# captures the structure of the code including all documentation.
|
# captures the structure of the code including all documentation.
|
||||||
# The default value is: NO.
|
# The default value is: NO.
|
||||||
|
|
||||||
GENERATE_XML = YES
|
GENERATE_XML = NO
|
||||||
|
|
||||||
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
|
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
|
||||||
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
|
2
Pipfile
2
Pipfile
@ -5,8 +5,6 @@ name = "pypi"
|
|||||||
|
|
||||||
[packages]
|
[packages]
|
||||||
platformio = "*"
|
platformio = "*"
|
||||||
sphinx = "*"
|
|
||||||
breathe = "*"
|
|
||||||
|
|
||||||
[dev-packages]
|
[dev-packages]
|
||||||
|
|
||||||
|
1
docs/.gitignore
vendored
1
docs/.gitignore
vendored
@ -1 +0,0 @@
|
|||||||
_build
|
|
@ -1,20 +0,0 @@
|
|||||||
# Minimal makefile for Sphinx documentation
|
|
||||||
#
|
|
||||||
|
|
||||||
# You can set these variables from the command line, and also
|
|
||||||
# from the environment for the first two.
|
|
||||||
SPHINXOPTS ?=
|
|
||||||
SPHINXBUILD ?= sphinx-build
|
|
||||||
SOURCEDIR = .
|
|
||||||
BUILDDIR = _build
|
|
||||||
|
|
||||||
# Put it first so that "make" without argument is like "make help".
|
|
||||||
help:
|
|
||||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
||||||
|
|
||||||
.PHONY: help Makefile
|
|
||||||
|
|
||||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
||||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
||||||
%: Makefile
|
|
||||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
0
docs/_static/.gitkeep
vendored
0
docs/_static/.gitkeep
vendored
0
docs/_templates/.gitkeep
vendored
0
docs/_templates/.gitkeep
vendored
50
docs/conf.py
50
docs/conf.py
@ -1,50 +0,0 @@
|
|||||||
# Configuration file for the Sphinx documentation builder.
|
|
||||||
#
|
|
||||||
# For the full list of built-in configuration values, see the documentation:
|
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
||||||
|
|
||||||
# -- Project information -----------------------------------------------------
|
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
|
||||||
|
|
||||||
project = 'Renderbug'
|
|
||||||
copyright = '2023, Victoria Fierce'
|
|
||||||
author = 'Victoria Fierce'
|
|
||||||
|
|
||||||
# -- General configuration ---------------------------------------------------
|
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
||||||
|
|
||||||
extensions = ['breathe']
|
|
||||||
|
|
||||||
breathe_projects = {"renderbug": "../xml"}
|
|
||||||
|
|
||||||
breathe_default_project = "renderbug"
|
|
||||||
|
|
||||||
templates_path = ['_templates']
|
|
||||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTML output -------------------------------------------------
|
|
||||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
||||||
|
|
||||||
html_theme = 'alabaster'
|
|
||||||
html_static_path = ['_static']
|
|
||||||
|
|
||||||
import subprocess, sys, os
|
|
||||||
|
|
||||||
def generate_doxygen_xml(app):
|
|
||||||
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
|
|
||||||
|
|
||||||
if read_the_docs_build:
|
|
||||||
try:
|
|
||||||
retcode = subprocess.call("cd ../; doxygen", shell=True)
|
|
||||||
if retcode < 0:
|
|
||||||
sys.stderr.write("doxygen terminated by signal %s" % (-retcode))
|
|
||||||
except OSError as e:
|
|
||||||
sys.stderr.write("doxygen execution failed: %s" % e)
|
|
||||||
|
|
||||||
|
|
||||||
def setup(app):
|
|
||||||
|
|
||||||
# Add hook for building doxygen xml when needed
|
|
||||||
app.connect("builder-inited", generate_doxygen_xml)
|
|
@ -1,24 +0,0 @@
|
|||||||
.. Renderbug documentation master file, created by
|
|
||||||
sphinx-quickstart on Sat Mar 4 13:04:23 2023.
|
|
||||||
You can adapt this file completely to your liking, but it should at least
|
|
||||||
contain the root `toctree` directive.
|
|
||||||
|
|
||||||
Welcome to Renderbug's documentation!
|
|
||||||
=====================================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
:caption: Contents:
|
|
||||||
|
|
||||||
|
|
||||||
API Documentation
|
|
||||||
=================
|
|
||||||
|
|
||||||
.. doxygenindex::
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
Loading…
Reference in New Issue
Block a user