From 57bd4d258940354b9d887f1c344cc05aa555d3e9 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Tue, 4 Jun 2024 16:17:57 +0200 Subject: [PATCH] smaller fixes for documentation --- CHANGELOG.md | 5 +++++ docs/conf.py | 1 + docs/index.rst | 4 ++-- pyproject.toml | 2 +- 4 files changed, 9 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e77a7f7..4c95b59 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/). # [unreleased] +# [v0.1.2] 2024-06-04 + +Updated documentation configuration to include a `spacepackets` docs mapping. This +should fix references to the `spacepackets` documentation. + # [v0.1.1] 2024-04-23 - Allow `spacepackets` range from v0.23 to < v0.25 diff --git a/docs/conf.py b/docs/conf.py index 05ee82b..20843f6 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -61,6 +61,7 @@ # Mapping for external packages intersphinx_mapping = { "python": ("https://docs.python.org/3", None), + "spacepackets": ("https://spacepackets.readthedocs.io/en/latest/", None), "crcmod": ("https://crcmod.sourceforge.net/", None), } diff --git a/docs/index.rst b/docs/index.rst index 3ef3cc6..4f53bab 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,9 +5,9 @@ .. _cfdp: -============================================================== +================================================================ cfdp-py - A library for the CCSDS File Delivery Protocol (CFDP) -============================================================== +================================================================ The ``cfdp-py`` library offers some high-level CCSDS File Delivery Protocol (CFDP) components to perform file transfers according to the `CCSDS Blue Book 727.0-B-5`_. The underlying base packet diff --git a/pyproject.toml b/pyproject.toml index 22dee11..0247f2f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta" name = "cfdp-py" description = "Library for high level CCSDS File Delivery Protocol (CFDP) components" readme = "README.md" -version = "0.1.1" +version = "0.1.2" requires-python = ">=3.8" license = {text = "Apache-2.0"} authors = [