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

Remove tox and adjust markdown files #1159

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

mgiulini
Copy link
Contributor

@mgiulini mgiulini commented Nov 26, 2024

You are about to submit a new Pull Request. Before continuing make sure you read the contributing guidelines.

Checklist

  • Tests added for the new code
  • Documentation added for the code changes
  • Does not break licensing
  • Does not add any dependencies, if it does please add a thorough explanation

Summary of the Pull Request

Related Issue

Closes #1157 by eliminating references to tox and updating the content of contributing.md file.

Additional Info

@mgiulini mgiulini changed the title Remove tox and adjust Remove tox and adjust markdown files Nov 26, 2024
@mgiulini mgiulini marked this pull request as ready for review November 26, 2024 12:49
@mgiulini mgiulini requested a review from a team November 26, 2024 12:50
@mgiulini mgiulini self-assigned this Nov 26, 2024
@mgiulini mgiulini added documentation Improve docs dependencies Pull requests that update a dependency file labels Nov 26, 2024
CONTRIBUTING.md Outdated Show resolved Hide resolved
Comment on lines +178 to +179
- install HADDOCK in development mode with the `docs` extra requirements
(`pip install -e '.[docs]'`)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- install HADDOCK in development mode with the `docs` extra requirements
(`pip install -e '.[docs]'`)
- install HADDOCK in development mode with the `dev` and `docs` extra requirements
(`pip install -e '.[dev,docs]'`)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

no need to install dev requirements to render the documentation


```bash
tox -e docs
pip install -e '.[docs]'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
pip install -e '.[docs]'
pip install -e '.[dev,docs]'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

same as above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improve docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

remove tox references and update README
2 participants