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

Documentation update for v0.10 #26

Merged
merged 36 commits into from
Feb 3, 2022

Conversation

jeandet
Copy link
Member

@jeandet jeandet commented Jan 22, 2022

Mostly a Documentation rewrite with the following notable changes:

  • The documentation is split in two, one user doc written in rst files only and one API doc generated from docstrings
  • The doc format used is numpydoc since it has a better rendering inside IPython terminal
  • All examples except the one which require a login are tested on CI with doctest e72bb70

It also:

  • drops python 3.6 support 69aa198
  • adds python 3.10 support 69aa198
  • deprecates and rename get_orbit from sscweb module to get_trajectory 52008a2, f2f4fb4
  • adds citation file 904c824
  • adds missing history entries for past releases 78453aa
  • adds a notebook gallery a59831f with clickable examples code 450e6ed
  • refactors notebooks examples a59831f and ce84a50

We should be able to release (0.10.0) now and continue improving documentation on each release.

@jeandet jeandet added documentation Improvements or additions to documentation WIP Work In Progress (don't merge) labels Jan 22, 2022
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
- AMDA user doc focuses on use-case and general presentation while dev
doc documents API
- Switch to numpydoc format, it has the advantage to work well in
IPython
- Examples needed a global rewrite to work with numpydoc+doctest,
testsetup doesn't work anymore which is not necessary bad. This implies
that examples will always work when copy/pasted.

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Also renamed get_orbit to get_trajectory which seems better

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
@jeandet jeandet force-pushed the documentation_update_v0.10 branch 3 times, most recently from c46505a to e866dd9 Compare January 24, 2022 15:58
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
GH Actions blocks secrets for pull requests from forks, which makes sense
since it wouldn't be safe. So we can't test user product access from
documentation examples. One improvement would be to find how to skip them
conditionally on PR or when no credentials are available.

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
@codecov
Copy link

codecov bot commented Jan 24, 2022

Codecov Report

Merging #26 (1930377) into main (27b9e6c) will decrease coverage by 1.36%.
The diff coverage is 95.45%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main      #26      +/-   ##
==========================================
- Coverage   86.91%   85.54%   -1.37%     
==========================================
  Files          31       31              
  Lines        1467     1474       +7     
  Branches      209      248      +39     
==========================================
- Hits         1275     1261      -14     
- Misses        130      150      +20     
- Partials       62       63       +1     
Flag Coverage Δ
unittests 85.54% <95.45%> (-1.37%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
speasy/products/catalog.py 94.87% <ø> (ø)
speasy/products/dataset.py 96.96% <ø> (+9.09%) ⬆️
speasy/products/timetable.py 96.55% <ø> (ø)
speasy/products/variable.py 93.10% <ø> (+1.14%) ⬆️
speasy/webservices/amda/__init__.py 100.00% <ø> (ø)
speasy/webservices/amda/inventory.py 96.66% <ø> (ø)
speasy/webservices/ssc/__init__.py 85.71% <60.00%> (-2.35%) ⬇️
speasy/__init__.py 90.00% <100.00%> (ø)
speasy/config/__init__.py 95.55% <100.00%> (ø)
speasy/core/__init__.py 95.00% <100.00%> (-2.50%) ⬇️
... and 10 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 27b9e6c...1930377. Read the comment docs.

…strings

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Also drops notebooks entry from TOC

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
fixes improvements

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
…urls

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
…package

@nicolasaunai this is for you ;)

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
…ng setup.py

RTD uses setup.py to install speasy from source and so astropy which is
not supported anymore by astropy. Adding astropy to doc requirements
should solve this issue since it is installed before speasy.

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
… RTD

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
@jeandet jeandet removed the WIP Work In Progress (don't merge) label Jan 28, 2022
@jeandet jeandet marked this pull request as ready for review January 28, 2022 09:32
@jeandet jeandet requested a review from Dolgalad January 28, 2022 09:32
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
@jeandet jeandet linked an issue Feb 1, 2022 that may be closed by this pull request
@jeandet
Copy link
Member Author

jeandet commented Feb 1, 2022

I've added #33 trivial fix commit to merge all at once.

@jeandet jeandet merged commit 588a371 into SciQLop:main Feb 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PSP IS⊙IS instruments cause "invalid character"
2 participants