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

Misc fixes for doc #41

Merged
merged 1 commit into from
Sep 8, 2023
Merged

Misc fixes for doc #41

merged 1 commit into from
Sep 8, 2023

Conversation

TL231
Copy link
Contributor

@TL231 TL231 commented Sep 8, 2023

Some small fixes for workflow related issues.

  1. Added doctest and coverage extension for workflow.
  2. Renamed docs to doc since that's what the workflow looks for, let me know if this causes an issue.
  3. Added _static folder and some static files from qibo repo, it's the logo and css to stop doctest from reporting missing static folder.

@TL231 TL231 requested a review from damarkian September 8, 2023 03:23
@codecov
Copy link

codecov bot commented Sep 8, 2023

Codecov Report

Patch has no changes to coverable lines.

📢 Thoughts on this report? Let us know!.

@damarkian damarkian merged commit 11193ce into main Sep 8, 2023
6 checks passed
@damarkian damarkian deleted the dev/docs branch September 8, 2023 23:59
@damarkian damarkian restored the dev/docs branch September 9, 2023 00:04
@damarkian
Copy link
Contributor

Getting this error on merge:

Configuration error:
This documentation is not using furo.css as the stylesheet. If you have set html_style in your conf.py file, remove it.
make: *** [Makefile:20: html] Error 2
make: Leaving directory '/home/runner/work/qibochem/qibochem/doc'
Error: Process completed with exit code 2.

@TL231
Copy link
Contributor Author

TL231 commented Sep 9, 2023

Google search says it's a sphinx 6.x version error, sure enough, the sphinx version in our poetry is 6.2.1.
I'll test it in another branch since the doc building/testing workflow is currently only set to fire when merging into the main so need some workflow changes to test it.

@damarkian damarkian deleted the dev/docs branch September 11, 2023 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants