Skip to content

Commit

Permalink
Readthedocs fixes (#152)
Browse files Browse the repository at this point in the history
* * Adding a g++ strict-safe version of strncpy to all usages of strncpy

* * Simplified the preincrement and decrement of KnowledgeRecord. Hopefully, this will also fix the warnings in KnowledgeRecord in workflow/CI also.
* Fixed a formatting issue in GlobalLogger

* * Adding checked pointer logging macro for those classes that may have a potential null pointer for a logger pointer

* * Fixed an issue in network containers that was causing warnings in strictest mode

* * Removing warnings where possible in strict compilation

* * Removed additional warning from Counter container

* * Attempting to fix warnings related to emplace in KnowledgeRecord on Github workflows
* Renaming ubuntu-tests to madara-tests and will eventually make this action more universal for supported platforms
* Updated README.md to hopefully view status of madara-tests.yaml as build indicator

* * Updated to version 3.4.0

* * Attempting to reconnect readthedocs to doxygen generation

* * Attempting to fix sphinx and doxygen integration

* * Updated readthedocs config to install doxygen and graphviz

* * Added texlive-font-utils dependency to read the docs
  • Loading branch information
jredmondson committed Dec 23, 2023
1 parent e9dc2f7 commit f8798c0
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ version: 2
# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
apt_packages:
- doxygen
- graphviz
- texlive-font-utils

tools:
python: "3.12"
# You can also specify other tool versions:
# nodejs: "20"
# rust: "1.70"
# golang: "1.20"

# Build documentation in the "docs/" directory with Sphinx
sphinx:
configuration: docs/conf.py
Expand All @@ -23,8 +27,8 @@ sphinx:
# fail_on_warning: true

# Optionally build your docs in additional formats such as PDF and ePub
# formats:
# - pdf
formats:
- pdf
# - epub

# Optional but recommended, declare the Python requirements required
Expand Down

0 comments on commit f8798c0

Please sign in to comment.