search

ni / niveristand-python

MIT License
17 stars 19 forks source link

add readthedocs.yaml, remove magic mock and old dependency locks #78

Closed papowerNI closed 9 months ago

papowerNI commented 9 months ago

What does this Pull Request accomplish?

In this blog post ReadTheDocs announced that they were no longer installing an old, consistent version of sphinx, and they would now be using the latest as the default. The latest sphinx does not handle Magic Mock well and additionally the readthedocs.yaml defined here is now required. This PR removes the former and adds the latter.

Why should this Pull Request be merged?

ReadTheDocs is currently not building the documentation from this repo (has been failing since September), and it has not been correctly building some of the sections for several years now. This not only gets the builds back up and running but allows some sections of the API library to generate correctly now as shown below: niveristand-python 1.0.0 -> 3.0.0 all had the issue below image

vs this PR image

What testing has been done?

Built locally with tox -e docs -r and browsed the documentation that was output locally, and checked a build on readthedocs as well https://niveristand-python.readthedocs.io/en/dev-specify-sphinx/index.html. Note that this URL may stop working after the PR is merged.

aaron-ni commented 9 months ago

So how do we run a test build on readthedocs with this branch to see if it fixes our issue there? (And to check that we aren't introducing new issues like broken links, broken page layout, etc)

papowerNI commented 9 months ago

@aaron-ni

So how do we run a test build on readthedocs with this branch to see if it fixes our issue there? (And to check that we aren't introducing new issues like broken links, broken page layout, etc)

I generated a page on readthedocs based on this branch instead of master for verification

aaron-ni commented 9 months ago

@papowerNI

I generated a page on readthedocs based on this branch instead of master for verification

Looking at the docs, the copyright on the bottom reads 2018:

© Copyright 2018, National Instruments Revision 775df4c7.

This is true both in the main branch as well as your branch - can we fix that too while we're updating docs?

papowerNI commented 9 months ago

@papowerNI

I generated a page on readthedocs based on this branch instead of master for verification

Looking at the docs, the copyright on the bottom reads 2018:

© Copyright 2018, National Instruments Revision 775df4c.

This is true both in the main branch as well as your branch - can we fix that too while we're updating docs?

updated to use the current year