Skip to content

Fix readthedocs issues #216

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
Merged
merged 5 commits into from
Jul 4, 2018
Merged

Fix readthedocs issues #216

merged 5 commits into from
Jul 4, 2018

Conversation

murrayrm
Copy link
Member

@murrayrm murrayrm commented Jul 4, 2018

This PR contains a bunch of small changes that fix problems with getting documentation to compile correctly on Read the Docs:

  • Updated conf.py (by regenerating with sphinx-autostart and copying over information.
  • Fixed a bunch of warnings in docstrings, usually related to escaping asterisks (*)
  • Changed a few other things for consistency (quote marks, indentation, blank lines, etc)
  • Changed "0 dB" to "1" in margins.py, to avoid EE-centric terminology
  • Updated the readthedocs requirements list
  • Got rid of the use of mock (didn't seem to need it once numpy, scipy, matplotlib were imported in doc-requirements)
  • Updated chapter, section headings in .rst files to be more consistent

@coveralls
Copy link

Coverage Status

Coverage remained the same at 78.962% when pulling d8e5684 on murrayrm:fix_readthedocs into 26661f6 on python-control:master.

1 similar comment
@coveralls
Copy link

coveralls commented Jul 4, 2018 •
edited
Loading

Coverage Status

Coverage remained the same at 78.962% when pulling d8e5684 on murrayrm:fix_readthedocs into 26661f6 on python-control:master.

@murrayrm murrayrm merged commit f79fbe4 into python-control:master Jul 4, 2018
@murrayrm murrayrm mentioned this pull request Jul 4, 2018
Closed
@murrayrm murrayrm added this to the 0.8.0 milestone Jul 4, 2018
@murrayrm murrayrm deleted the fix_readthedocs branch July 4, 2018 18:18
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.8.0
Development

Successfully merging this pull request may close these issues.
2 participants
@murrayrm @coveralls