Skip to content

Commit

Permalink
doc corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
robamu committed Jan 24, 2024
1 parent 1ce46ff commit ed7a5a1
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[![ci](https://github.com/us-irs/cfdp-py/actions/workflows/ci.yml/badge.svg)](https://github.com/us-irs/cfdp-py/actions/workflows/ci.yml)
[![Documentation Status](https://readthedocs.org/projects/cfdppy/badge/?version=latest)](https://cfdppy.readthedocs.io/en/latest/?badge=latest)
[![Documentation Status](https://readthedocs.org/projects/cfdp-py/badge/?version=latest)](https://cfdp-py.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/us-irs/cfdp-py/graph/badge.svg?token=YFLM60LCVI)](https://codecov.io/gh/us-irs/cfdp-py)
[![PyPI version](https://badge.fury.io/py/cfdppy.svg)](https://badge.fury.io/py/cfdppy)

Expand Down
8 changes: 4 additions & 4 deletions docs/api/cfdp.handler.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@ CFDP Handler Package
Package Contents
-----------------

.. automodule:: cfdpy.handler
.. automodule:: cfdppy.handler
:members:
:undoc-members:
:show-inheritance:

Source Handler Module
-------------------------------------

.. automodule:: cfdpy.handler.source
.. automodule:: cfdppy.handler.source
:members:
:undoc-members:
:show-inheritance:

Destination Handler Module
-------------------------------------

.. automodule:: cfdpy.handler.dest
.. automodule:: cfdppy.handler.dest
:members:
:undoc-members:
:show-inheritance:

Defintions Module
-------------------------------------

.. automodule:: cfdpy.handler.defs
.. automodule:: cfdppy.handler.defs
:members:
:undoc-members:
:show-inheritance:
14 changes: 7 additions & 7 deletions docs/api/cfdp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ CFDP Package
Module contents
---------------

.. automodule:: cfdpy
.. automodule:: cfdppy
:members:
:undoc-members:
:show-inheritance:

Filestore Module
-------------------------------

.. automodule:: cfdpy.filestore
.. automodule:: cfdppy.filestore
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -21,39 +21,39 @@ Filestore Module
Management Information Base (MIB) Module
-------------------------------------------

.. automodule:: cfdpy.mib
.. automodule:: cfdppy.mib
:members:
:undoc-members:
:show-inheritance:

Request Module
-------------------------------

.. automodule:: cfdpy.request
.. automodule:: cfdppy.request
:members:
:undoc-members:
:show-inheritance:

User Module
-------------------------------

.. automodule:: cfdpy.user
.. automodule:: cfdppy.user
:members:
:undoc-members:
:show-inheritance:

Exceptions Module
-------------------------------------------

.. automodule:: cfdpy.exceptions
.. automodule:: cfdppy.exceptions
:members:
:undoc-members:
:show-inheritance:

Definitions Module
--------------------------

.. automodule:: cfdpy.defs
.. automodule:: cfdppy.defs
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
author = "Robin Mueller"

# The full version, including alpha/beta/rc tags
release = version = version("cfdppy")
release = version = version("cfdp-py")


# -- General configuration ---------------------------------------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
.. _cfdp:

==============================================================
cfdpy - A library for the CCSDS File Delivery Protocol (CFDP)
cfdp-py - A library for the CCSDS File Delivery Protocol (CFDP)
==============================================================

The ``cfdpy`` package offers some high-level CCSDS File Delivery Protocol (CFDP) components to
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
library used to generate the packets to be sent is the `spacepackets`_ library.

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[build-system]
requires = ["setuptools"]
requires = ["setuptools>=0.62.0"]
build-backend = "setuptools.build_meta"

[project]
Expand Down

0 comments on commit ed7a5a1

Please sign in to comment.