Skip to content
This repository has been archived by the owner on Aug 2, 2024. It is now read-only.

Have new projects use the Furo theme for Sphinx, and update pre-commit job versions #1

Merged
merged 6 commits into from
Aug 11, 2021

Conversation

ScriptAutomate
Copy link
Contributor

@ScriptAutomate ScriptAutomate commented Mar 31, 2021

  • Shift to furo theme for docs
  • Extend noxfile.py for more docs stuff
  • Update pre-commit reqs
  • Drop py3.5 from pre-commit config reqs

I, admittedly, couldn't properly get the nox command nox -e docs to work at all on a new project. It would just continuously fail. But I didn't want to remove it entirely, so I added different nox commands that did work in case I may have been missing something. This PR does remove the old nox -e docs job in favor of the new docs jobs, but that does mean that it currently does not include make linkcheck and make coverage as Sphinx tests.

I also wonder whether I should be dropping the pre-commit configs that focus on using pip-compile because nox purely references the setup.cfg rather than requirements/* now, and doesn't make a tree unless someone explicitly does so.

@ScriptAutomate ScriptAutomate marked this pull request as ready for review August 10, 2021 01:10
@ScriptAutomate ScriptAutomate marked this pull request as draft August 10, 2021 01:24
@ScriptAutomate ScriptAutomate marked this pull request as ready for review August 10, 2021 19:01
@ScriptAutomate ScriptAutomate changed the title Have new projects use the Furo theme for Sphinx Have new projects use the Furo theme for Sphinx, and update pre-commit job versions Aug 10, 2021
Copy link
Contributor

@s0undt3ch s0undt3ch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove the old docs target of the new ones do the work needed.

@ScriptAutomate
Copy link
Contributor Author

ScriptAutomate commented Aug 10, 2021

Remove the old docs target of the new ones do the work needed.

I've now removed the older nox -e docs jobs in favor of newer doc-html and docs-dev jobs. I've also updated the original description of this PR with more info. I'm wondering whether certain pre-commit information should potentially be removed or simply stay.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants