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

Updated documentation #50

Merged
merged 24 commits into from Jun 2, 2020
Merged

Conversation

HealthyPear
Copy link
Member

@HealthyPear HealthyPear commented May 13, 2020

Closes #27

Description:

This pull request updates and restructures the whole documentation with a layout inspired by both ctapipe and gammapy.

It also contains a static version of the current benchmarks, which will be updated here from now on. The notebooks coincide with those contained in the notebooks folder at the root of the repository.

Caveats:

  • README information didn't change, but could be removed or simplified, since everything is in the documentation,
  • some details will be sorted out via smaller PRs in the future,
  • information about the installation and usage of material related to the grid has been temporarily removed. It will be added as soon as the successful local tests will be replicated online.

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

Review Jupyter notebook visual diffs & provide feedback on notebooks.


Powered by ReviewNB

@HealthyPear HealthyPear added documentation Documentation or services hosting it enhancement New feature or request labels May 13, 2020
@HealthyPear HealthyPear added this to the Release 0.3 milestone May 13, 2020
@HealthyPear HealthyPear added this to In progress in Pipeline features and enhancements via automation May 13, 2020
@codecov
Copy link

codecov bot commented May 13, 2020

Codecov Report

Merging #50 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff           @@
##           master     #50   +/-   ##
======================================
  Coverage    0.40%   0.40%           
======================================
  Files          20      20           
  Lines        2232    2232           
======================================
  Hits            9       9           
  Misses       2223    2223           

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 d928c4c...484f213. Read the comment docs.

Pipeline features and enhancements automation moved this from In progress to Reviewer approved Jun 2, 2020
@HealthyPear HealthyPear merged commit c46571c into cta-observatory:master Jun 2, 2020
Pipeline features and enhancements automation moved this from Reviewer approved to Done Jun 2, 2020
@HealthyPear HealthyPear deleted the update_docs branch June 2, 2020 08:31
@HealthyPear HealthyPear removed the enhancement New feature or request label Oct 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation or services hosting it
Development

Successfully merging this pull request may close these issues.

Improve and update the documentation
2 participants