-
Notifications
You must be signed in to change notification settings - Fork 6
build(docs): update Starter Pack and add passthrough to docs Makefile #478
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build(docs): update Starter Pack and add passthrough to docs Makefile #478
Conversation
|
The workflows are failing: This wasn't a problem before because we allowed warnings, but the Starter Pack has |
|
Removed sphinx-toolbox as it appears none of our repos are using it. Fixed RTD build and linting. @jahn-junior @bepri @lengau Ready for review. |
|
Command output |
It should be fixed with d7c5398 |
bepri
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! For some reason, getting this to work required me to delete and remake my virtual environment first.
make docs-pymarkdownlnt doesn't work because it runs make docs-pymarkdownlnt-install, which runs pip install, which is rejected by uv-managed venvs.
make docs-spelling finds a lot of false positives.
Everything else seems to work! (unless you consider running npm install on my machine to be an issue)
Hmm. That's an odd one. Let's discuss that offline.
I'll noop this one, since we're never going to use it.
That's where the fun starts. :) I'll make the corrections in a follow-up. |
40500b3 to
37b7e64
Compare
|
@bepri Rebased and ready for final approval. I could recreate the venv issue with JJ but not Alex. There's no reason in principle for it to be happening. Switching to main, building, and then back to the branch doesn't replicate the issue. |
jahn-junior
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Leaving this as a blocking review due to issues running make commands from within the docs directory.
Add aliases and passthrough Make targets provided by the docs project. With this, you can run make at the root of the project and access docs commands. The behaviour is: - `docs` safely calls `html` - `docs-auto` safely calls `serve` - `docs-clean` safely calls `clean` - `docs-install` calls `vale-install` and then calls root `setup-docs` - `docs-*` passes through to all other doc targets The goal is to keep the docs build nearly unedited. For this to work as of Starter Pack 1.3.1, the `VALEDIR` var in the docs Makefile must be changed to a conditional assignment (`?=`).
7d0bd9a to
152e4aa
Compare
Add aliases and passthrough Make targets provided by the docs project. With this, you can run make at the root of the project and access docs commands. The behaviour is:
docssafely callshtmldocs-autosafely callsservedocs-cleansafely callscleandocs-installcallsvale-installand then calls rootsetup-docsdocs-*passes through to all other doc targetsThe goal is to keep the docs build nearly unedited. For this to work as of Starter Pack 1.3.1, the
VALEDIRvar in the docs Makefile must be changed to a conditional assignment (?=).make lint && make test.