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.

Sign up for GitHub

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

Jump to bottom

Add necessary hooks to link PRs, Issues and users in documentation #15

Closed
1 task
RondeauG opened this issue Jun 14, 2023 · 3 comments · Fixed by #16
Closed
1 task

Add necessary hooks to link PRs, Issues and users in documentation #15

RondeauG opened this issue Jun 14, 2023 · 3 comments · Fixed by #16
Assignees
@Zeitsperre
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@RondeauG
Copy link
Collaborator

Addressing a Problem?

Links following the format (:pull:number) are used throughout a few files such as HISTORY.rst to link to previous PRs, Issues, and Users. However, the proper sphinx hooks need to be implemented for them to work.

Potential Solution

No response

Additional context

No response

Contribution

  • I would be willing/able to open a Pull Request to contribute this feature.
@RondeauG RondeauG added the enhancement New feature or request label Jun 14, 2023
@Zeitsperre Zeitsperre added the documentation Improvements or additions to documentation label Jun 14, 2023
@Zeitsperre
Copy link
Collaborator

Sounds good. There are a few things I can add to the cookiecutter to enable this functionality. I think it's totally worth it.

@Zeitsperre
Copy link
Collaborator

Related: #14

@Zeitsperre
Copy link
Collaborator

This is merged (#14), but because we place the history in the metadata sent to PyPI, this is causing an error. We need to remove this info, unfortunately. Will address tomorrow.

@Zeitsperre Zeitsperre mentioned this issue Jun 16, 2023
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Zeitsperre Zeitsperre

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Metadata fixes hydrologie/xhydro
2 participants
@Zeitsperre @RondeauG