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

Improve documentation theme #3817

Merged
merged 26 commits into from Feb 21, 2022
Merged

Improve documentation theme #3817

merged 26 commits into from Feb 21, 2022

Conversation

Bultako
Copy link
Member

@Bultako Bultako commented Feb 18, 2022

This PR addresses most of the feedback gathered in #3746:

  • style more similar to https://gammapy.org/
  • changelog refactored into individual RST pages
  • moved Dependencies to Development section
  • link to recipes as a panel box in Userguide
  • link to tutorials in Useful links in home page
  • text modified and reduced on homepage
  • add acknowledge link in the nav bar
  • add slack icon in the bav bar
  • fix warnings in docstrings
  • order models in API
  • add version switching select box in the nav bar

Still some modifs missing and to be done in another PR:

  • modify the text and style of HowTo panels
  • refactor and move text in API ref index pages

You may access how the docs shows with this PR in the usual link.

@codecov
Copy link

codecov bot commented Feb 18, 2022

Codecov Report

Merging #3817 (d5aa90a) into master (1c043d3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3817   +/-   ##
=======================================
  Coverage   93.83%   93.83%           
=======================================
  Files         162      162           
  Lines       19778    19778           
=======================================
  Hits        18558    18558           
  Misses       1220     1220           
Impacted Files Coverage Δ
gammapy/data/data_store.py 90.87% <ø> (ø)
gammapy/data/event_list.py 94.72% <ø> (ø)
gammapy/datasets/map.py 93.25% <ø> (ø)
gammapy/estimators/points/profile.py 90.47% <ø> (ø)
gammapy/estimators/utils.py 90.90% <ø> (ø)
gammapy/irf/core.py 89.35% <ø> (ø)
gammapy/irf/edisp/kernel.py 98.47% <ø> (ø)
gammapy/irf/psf/parametric.py 92.48% <ø> (ø)
gammapy/makers/background/reflected.py 97.79% <ø> (ø)
gammapy/makers/background/ring.py 97.05% <ø> (ø)
... and 9 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1c043d3...d5aa90a. Read the comment docs.

@Bultako Bultako self-assigned this Feb 18, 2022
@bkhelifi
Copy link
Member

Thanks a lot Jose Enrique, looks nice...
A fast question: have we decided if we promote a bit the use of mamba? Because in the 'getting started' it is not mentioned

@Bultako
Copy link
Member Author

Bultako commented Feb 18, 2022

@bkhelifi
well, it is actually mentioned https://docs.gammapy.org/dev/search.html?q=mamba
though maybe not in a prominent way..

@bkhelifi
Copy link
Member

In https://www.iaa.csic.es/~jer/gammapydocs/userguide/index.html,

  • the recipes do not appear in the left column...
  • Should we not make 2 boxes for the first 2 items (gamma-ray analysis and package structure)? An open question...

@Bultako
Copy link
Member Author

Bultako commented Feb 18, 2022

the recipes do not appear in the left column...

Done

I also added the slack icon and one acknowledge link in the nav bar.
This is now ready for review.

@adonath
Copy link
Member

adonath commented Feb 18, 2022

Thanks a lot @Bultako! For now I only have two minor comments:

  • The fontsize in the navbar could a bit larger
  • The version switch would be great
    Otherwise I'd be happy to merge this any time...

@adonath adonath added this to the 1.0 milestone Feb 18, 2022
@adonath adonath added the docs label Feb 18, 2022
Copy link
Contributor

@registerrier registerrier left a 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?

docs/development/doc_howto.rst Show resolved Hide resolved
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Bultako
Copy link
Member Author

Bultako commented Feb 21, 2022

@adonath @registerrier

Your last comments have been addressed.

  • fontsize in the navbar a bit larger
  • version switcher implemented
  • recover CHANGES.rst (event if we have duplicated content, I agree it is good to have it at the root level of the repo, at least for quick inspection in github)
  • amend text on how to build docs as a pdf file

You may have a quick look at the usual link.
Otherwise, ready to merge from my side.

Copy link
Member

@adonath adonath left a 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.

@adonath
Copy link
Member

adonath commented Feb 21, 2022

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.

@adonath
Copy link
Member

adonath commented Feb 21, 2022

Thanks a lot @Bultako!

@adonath adonath merged commit b6f354f into gammapy:master Feb 21, 2022
@adonath adonath self-assigned this Feb 21, 2022
@Bultako Bultako deleted the improve-docs branch February 22, 2022 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants