-
Notifications
You must be signed in to change notification settings - Fork 7
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
Conversation
- 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>
b4611d9
to
ec12968
Compare
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
c46505a
to
e866dd9
Compare
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
e866dd9
to
bcbe975
Compare
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>
e9673ea
to
e72bb70
Compare
Codecov Report
@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
…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>
…/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files 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>
f865563
to
a59831f
Compare
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>
d642869
to
f16806a
Compare
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
f16806a
to
07cf307
Compare
…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>
e5610f9
to
eb90a5a
Compare
…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>
51e85ed
to
e535835
Compare
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
e535835
to
ce84a50
Compare
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>
I've added #33 trivial fix commit to merge all at once. |
Mostly a Documentation rewrite with the following notable changes:
It also:
We should be able to release (0.10.0) now and continue improving documentation on each release.