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

chore(docs): separate docs dependencies #1453

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft

Conversation

artemrys
Copy link
Member

@artemrys artemrys commented Nov 12, 2024

Issue number: N/A

Summary

Changes

Moving docs-related dependencies out of pyproject.toml into a separate requirements-docs.txt file so we could update docs dependencies separately (otherwise we depend on Python 3.7).

It would allow us to have auto theme for docs which was introduced in mkdocs-material v9.5.0 (https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#automatic-light-dark-mode) which is not available if Python 3.7 is used.

User experience

N/A

Checklist

If your change doesn't seem to apply, please leave them unchecked.

@@ -139,7 +139,10 @@ Documentation changes are also welcome!
To verify changes locally:

```bash
poetry run mkdocs serve -a localhost:8001
python3 -m venv .venv
Copy link
Contributor

@vtsvetkov-splunk vtsvetkov-splunk Nov 27, 2024

Choose a reason for hiding this comment

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

would it not mess up venv for docs and venv for the rest of the repo? I consider moving everything related to docs to docs/, including (or only?) mkdocs.yml

Then we can create .python-version file that can be picked up by pyenv and github action and have the docs/venv for better isolation

What do you think?

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

Successfully merging this pull request may close these issues.

2 participants