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

Switch theme to openff-sphinx-theme #234

Merged
merged 6 commits into from
Nov 8, 2021

Conversation

Yoshanuikabundi
Copy link
Collaborator

Description

New theme!! Let me know if you have any thoughts, we have a lot of flexibility with this theme.

Checklist

  • Add tests
  • Lint
  • Update docstrings

@codecov
Copy link

codecov bot commented Jun 23, 2021

Codecov Report

Merging #234 (b830cd9) into master (2448c33) will decrease coverage by 5.88%.
The diff coverage is n/a.

❗ Current head b830cd9 differs from pull request most recent head 6a0f57b. Consider uploading reports for the commit 6a0f57b to get more accurate results

@mattwthompson
Copy link
Member

Thanks @Yoshanuikabundi - I think this looks nice, and the unification is a huge plus. However, fI'd like to park this for a day or two while I get something more sensible off the ground. For example, the API docs are all completely broken, but mostly because everything tries to point to old modules names which no longer exist.

The only detail I could find right now is that some of the text in this sidebar looks clipped ((compon -> components): image

@mattwthompson
Copy link
Member

The above could/should probably be fixed with better-named headers. We'll see if I can figure that out

@mattwthompson mattwthompson mentioned this pull request Jun 23, 2021
3 tasks
@mattwthompson
Copy link
Member

Blocked by #235, which should also be good to go

@mattwthompson
Copy link
Member

What's our status with this, #271, and #255? Let me know if something is waiting on my review, or if you'd prefer any particular order of merging!

@Yoshanuikabundi
Copy link
Collaborator Author

I'm meeting with Simon to discuss the theme today and then I'll have more info about this one. As for #271 and #255, I was hoping to hear any of your preferences; we should close one and merge the other. As much as I love the idea of autoapi, I think autosummary is probably superior, especially since we can mock imports and since autodoc_pydantic is planning to support this use case in the near future.

@mattwthompson
Copy link
Member

mattwthompson commented Aug 11, 2021

In that case, I think that autosummary is the option we should go with!

@mattwthompson
Copy link
Member

Now that openforcefield/openff-toolkit#979 is merged, I think this should be ready to go?

@mattwthompson
Copy link
Member

This seems to have slipped through the cracks, but I don't think anything should conflict with this going live.

@mattwthompson mattwthompson merged commit 4d0fee5 into openforcefield:master Nov 8, 2021
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