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

[Documentation] Add information on building documentation and running tests locally #52

Closed
elbeejay opened this issue Feb 1, 2024 · 1 comment · Fixed by #53
Closed
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested

Comments

@elbeejay
Copy link

elbeejay commented Feb 1, 2024

It'd be great if the documentation included "instructions for developers" on things like:

  • Setting up a "developer" environment with an editable installation of the package
  • Building the documentation locally
  • Running the tests and calculating the code coverage locally

Current guidance on the contributing page does a good job covering how contributions should be made. It is unfortunate that the hyperlink in the readme (this) does not work, but since it works in the hosted documentation I'm wondering if changing it in the readme would break that link...

@elbeejay elbeejay added enhancement New feature or request question Further information is requested labels Feb 1, 2024
@g4brielvs g4brielvs added the documentation Improvements or additions to documentation label Feb 1, 2024
@g4brielvs g4brielvs linked a pull request Feb 1, 2024 that will close this issue
@g4brielvs
Copy link
Contributor

g4brielvs commented Feb 1, 2024

@elbeejay Thanks! Excepts for tests (see #21), #53 should address these items.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants