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

Fix Sphinx warnings #1405

Merged
merged 11 commits into from Oct 9, 2022
Merged

Conversation

zariiii9003
Copy link
Collaborator

I fixed all Sphinx warnings except for the nixnet interface, that one remains broken.
The documentation is now built in github actions.

@codecov
Copy link

codecov bot commented Oct 7, 2022

Codecov Report

Merging #1405 (7c7a092) into develop (89c395f) will increase coverage by 0.01%.
The diff coverage is 87.50%.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #1405      +/-   ##
===========================================
+ Coverage    65.25%   65.27%   +0.01%     
===========================================
  Files           81       81              
  Lines         8767     8769       +2     
===========================================
+ Hits          5721     5724       +3     
+ Misses        3046     3045       -1     

@zariiii9003
Copy link
Collaborator Author

@hardbyte Can you check whether the readthedocs build works as configured in .readthedocs.yml? Or could you somehow add me to the rtd admins?
Also: What do you think about the furo theme? It's the one that setuptools uses.

@hardbyte
Copy link
Owner

hardbyte commented Oct 9, 2022

@zariiii9003 the furo theme looks great. I've invited you as an admin to python-can on readthedocs.

@@ -0,0 +1,31 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
Copy link
Owner

Choose a reason for hiding this comment

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

👍🏼

@zariiii9003
Copy link
Collaborator Author

zariiii9003 commented Oct 9, 2022

I've invited you as an admin to python-can on readthedocs.

Thank you!

I will create another PR for furo.

@zariiii9003 zariiii9003 merged commit 451ce48 into hardbyte:develop Oct 9, 2022
@zariiii9003 zariiii9003 deleted the sphinx_warnings branch October 9, 2022 21:08
@zariiii9003
Copy link
Collaborator Author

zariiii9003 commented Oct 13, 2022

@hardbyte Can you resync the rtd webhook? You can find it in Admin -> Integrations -> GitHub incoming webhook -> Resync webhook. New pull requests should trigger a rtd rebuild once it is synced.

I do not have the permissions to to do that.

j-c-cook added a commit to j-c-cook/python-can that referenced this pull request Nov 11, 2022
@hardbyte
Copy link
Owner

Hmm resync didn't seem to work so I've deleted the webhook and added the read the docs integration from scratch. Thanks!

@felixdivo
Copy link
Collaborator

Wow @zariiii9003 this PR is wonderful!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants