Skip to content

Expand instructions for contributions and releases#69

Merged
oprypin merged 4 commits intomasterfrom
readme
Mar 29, 2026
Merged

Expand instructions for contributions and releases#69
oprypin merged 4 commits intomasterfrom
readme

Conversation

@oprypin
Copy link
Copy Markdown
Member

@oprypin oprypin commented Mar 29, 2026

No description provided.

@oprypin oprypin requested a review from Andre601 March 29, 2026 19:14
Comment on lines +124 to +134
> * Exact versions of dependencies:
>
> ```bash
> .venv/bin/pip install -r requirements/requirements-docs.txt # .
> ```
>
> * Latest versions of all dependencies:
>
> ```bash
> .venv/bin/pip install -r $(properdocs get-deps) #
> ```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The only issue I have with this, is that maybe people don't know how to use/setup venv?
Also, if they set up one locally (using venv command), then the structure of the folder may differ based on the OS.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Well this is true, but these instructions are already alternate instructions if you don't want to use Hatch.

I also don't want to recommend installing all the crazy dependencies without a virtualenv.

If you know a straightforward way to make these instructions general also for Windows users, you can follow up in a new pull request

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The only aproach I know is the one that I found in the Material for MkDocs documentation about making a reporoduction:

  • use venv venv to create a venv in the mkdocs folder
  • use . venv/Script/activate to activate the venv
  • Install stuff
  • deactivate with deactivate

I think this is fine for most users tho.

oprypin added 3 commits March 29, 2026 22:27
This is because the page is viewable on both GitHub and on the website

Also the Python-Markdown parsing of link references is partly broken, so avoid its quirks.
@oprypin oprypin merged commit 1759c41 into master Mar 29, 2026
23 checks passed
@oprypin oprypin deleted the readme branch March 29, 2026 20:54
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