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 documentation and upload to read the docs #22

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

MrRobot2211
Copy link
Collaborator

@MrRobot2211 MrRobot2211 commented Jul 9, 2021

This PR will solve issue #13.

  • Get documentation to build properly and import submodules
  • Add documentation readme
  • Upload to Read The Docs

Adds qutip_cupy.rst
includes it in the index.rst
@coveralls
Copy link

coveralls commented Jul 9, 2021

Pull Request Test Coverage Report for Build 1013456660

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 82.432%

Totals Coverage Status
Change from base Build 1005673719: 0.0%
Covered Lines: 61
Relevant Lines: 74

💛 - Coveralls

now qutip_cupy gets imported into the general index
@hodgestar
Copy link
Contributor

@MrRobot2211 Woot on getting the autodocs building. Let me know when the other tasks are done and you'd like further review.

@hodgestar
Copy link
Contributor

I've activated ReadTheDocs on this repository, so you should be able to see documentation builds now.

@hodgestar
Copy link
Contributor

P.S. I'm not sure if ReadTheDocs can build branches from your repository, so I might have to copy this into a branch here to check that it works. Let me know when the ReadTheDocs configuration files are ready to go and then I can do that.

@MrRobot2211
Copy link
Collaborator Author

@hodgestar From what I've seen we should include QuTiP=devmajor inside doc.requirements.txt for this to build properly on read_the_docs side. But I might well be mistaken

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.

3 participants