update docs to use use numpydoc + linkcode by murrayrm · Pull Request #828 · python-control/python-control

Skip to content

Navigation Menu

Sign in

Appearance settings

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up

Appearance settings

Conversation

@murrayrm

Copy link Copy Markdown

Member

@murrayrm murrayrm commented

Dec 29, 2022

edited

Loading

This PR updates documentation to use the numpydoc extension and also adds the linkcode extension. Include numpydoc seems to mainly check for consistency with NumPy documentation format, so it found a few inconsistencies that were fixed. The linkcode extension adds a link to the source code for each function to GitHub.

@murrayrm murrayrm added this to the 0.9.3 milestone

Dec 29, 2022

@coveralls

Copy link Copy Markdown

coveralls commented

Dec 29, 2022

edited

Loading

Coverage Status

Coverage: 94.846%. Remained the same when pulling ad7ce5f on murrayrm:numpydoc-28Dec2022 into 49b0077 on python-control:main.

@murrayrm murrayrm merged commit 508dc7f into python-control:main

Dec 30, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.9.3

Development

Successfully merging this pull request may close these issues.

2 participants

@murrayrm @coveralls