Skip to content
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

docs: Sync requirements-doc.txt with Poetry dev group till mkdocs works #428

Merged
merged 6 commits into from
Feb 12, 2024
Merged

docs: Sync requirements-doc.txt with Poetry dev group till mkdocs works #428

merged 6 commits into from
Feb 12, 2024

Conversation

ryanhalliday
Copy link
Contributor

I tried to get setup with the docs using Poetry but it didn't work with just poetry install and I had to use pip install -r requirements-docs.txt in a different venv.

So I did poetry add --group dev PACKAGE till it worked.

Added were:

  • mkdocs-jupyter
  • mkdocs-rss-plugin
  • mkdocs-minify-plugin
  • cairosvg
  • pillow

I installed each of pillow and cairosvg to match requirements-doc.txt instead of mkdocs-material[imaging] but installing that imaging package might be better?

I know mkdocs-jupyter is a recent addition but maybe seeing as it includes a bunch of stuff a poetry docs group could be good?

Hope this was the right thing to do?
Python packaging always feels kinda wild

Copy link
Contributor

ellipsis-dev bot commented Feb 11, 2024

Skipped PR review on c9c2fdd because no changed files had a supported extension. If you think this was in error, please contact us and we'll fix it right away.


Something look wrong? You can customize Ellipsis by editing the ellipsis.yaml for this repository.

Generated with ❤️ by ellipsis.dev

@jxnl
Copy link
Owner

jxnl commented Feb 12, 2024

Making a docs group would be awesome. And using imagery sounds like a good plan will merge when ready.

Will need to change contributing.md and some deployment workflows.

@jxnl jxnl self-requested a review February 12, 2024 03:35
@jxnl
Copy link
Owner

jxnl commented Feb 12, 2024

lets add a docs group and make sure test-docs and mkdocs works

@ryanhalliday
Copy link
Contributor Author

ryanhalliday commented Feb 12, 2024

Made the imaging change and fixed the --with param in workflows.

Test Docs is failing because of OpenAI secret in PR workflow?

I didn't add anything to contributing.md - alright if I leave that for you?

@jxnl jxnl merged commit 2cabb76 into jxnl:main Feb 12, 2024
7 of 8 checks passed
@ryanhalliday ryanhalliday deleted the docs-poetry-dependency-sync-2 branch February 12, 2024 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants