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
Improve documentation theme #3817
Conversation
fix sphinx warnings in docstrings
Codecov Report
@@ Coverage Diff @@
## master #3817 +/- ##
=======================================
Coverage 93.83% 93.83%
=======================================
Files 162 162
Lines 19778 19778
=======================================
Hits 18558 18558
Misses 1220 1220
Continue to review full report at Codecov.
|
Thanks a lot Jose Enrique, looks nice... |
@bkhelifi |
In https://www.iaa.csic.es/~jer/gammapydocs/userguide/index.html,
|
Done I also added the slack icon and one acknowledge link in the nav bar. |
Thanks a lot @Bultako! For now I only have two minor comments:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Bultako . This looks really great! I have only one comment.
Splitting the changelog reads very well. That's a very good idea.
But isn't it an issue if CHANGES.rst
is removed from the main directory?
We could keep it even if the content is duplicated between the general directory and the docs, no?
fe4d327
to
1f9ea5b
Compare
1f9ea5b
to
978b7e6
Compare
1927445
to
d662edb
Compare
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
518f748
to
61ea99e
Compare
Your last comments have been addressed.
You may have a quick look at the usual link. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot @Bultako, nor further comments from my side. Later I guess we could just implement a little helper script, that copies the changes into single CHANGES.rst
.
I'd love to see this online. So I'll go ahead and merge this. We can always implement changes and improvements in follow up PRs. |
Thanks a lot @Bultako! |
This PR addresses most of the feedback gathered in #3746:
Still some modifs missing and to be done in another PR:
You may access how the docs shows with this PR in the usual link.