Skip to content

Commit

Permalink
Merge pull request #441 from flask-dashboard/Read-the-docs-update
Browse files Browse the repository at this point in the history
Updated read the docs file
  • Loading branch information
wielas authored Dec 5, 2023
2 parents 48a1d7a + 5c4ba37 commit 95315d7
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 7 deletions.
33 changes: 28 additions & 5 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the OS, Python version and other tools you might need
build:
os: ubuntu-22.04
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
# You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
# builder: "dirhtml"
# Fail on all warnings to avoid broken references
# fail_on_warning: true

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

# Optional but recommended, declare the Python requirements required
# to build your documentation
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
version: 3.7
install:
- requirements: docs/requirements.txt

formats:
- html
- requirements: docs/requirements.txt
13 changes: 12 additions & 1 deletion docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,25 @@ All notable changes to this project will be documented in this file.
This project adheres to `Semantic Versioning <http://semver.org/>`_.
Please note that the changes before version 1.10.0 have not been documented.

v3.2.2
----------
Changed

- Fixed Sphinx documentation

v3.2.1
----------
Changed

- Removed sentry artifacts in code

v3.2.0
----------
Changed

- Upgraded multiple frontend packages for enhanced security and performance.
- Added survey alert
- Added telemetry alert and functionality
- Fixed Sphinx documentation


v3.1.2
Expand Down
2 changes: 1 addition & 1 deletion flask_monitoringdashboard/constants.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "3.2.1",
"version": "3.2.2",
"author": "Krzysztof Wielicki, Johannes Lind Christiansen",
"email": "flask.monitoringdashboard@gmail.com"
}

0 comments on commit 95315d7

Please sign in to comment.