Add readthedocs configuration file and fix errors preventing doc build. - Githubissues

ni / niflexlogger-automation-python

The niflexlogger-automation package contains an API (Application Programming Interface) and examples for using Python to automate NI FlexLogger. The automation API supports modifying the configuration of existing FlexLogger projects and controlling the execution of FlexLogger test sessions. The package is implemented in Python. NI created and supports this package.

MIT License

8 stars 6 forks source link

Add readthedocs configuration file and fix errors preventing doc build. #34

Closed ccaltagi closed 8 months ago

ccaltagi commented 8 months ago

[X] This contribution adheres to CONTRIBUTING.md.

What does this Pull Request accomplish?

My latest PR triggered a readthedocs build that failed https://readthedocs.org/projects/niflexlogger-automation/builds/22109507/ This is because readthedocs now requires a configuration file as of September 2023 and we didn't have any. This PR adds the configuration file and fixes docstrings errors I was getting in a couple files when trying to build locally. See https://docs.readthedocs.io/en/stable/config-file/v2.html I followed this tutorial to create the configuration file.

Why should this Pull Request be merged?

This PR enabled the automatic build of the readthedocs documentation when a PR is submitted.

What testing has been done?

Verified a local build works by running tox -e docs

[ ] I have run the automated tests (required if there are code changes) No code changes that affect functionality.