Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,16 +1,20 @@
version: 2

build:
image: latest
os: ubuntu-24.04
tools:
python: "3.11"

python:
version: 3.8
install:
- requirements: docs/requirements.txt
- method: pip
path: .
- requirements: docs/requirements.txt
- method: pip
path: .

sphinx:
builder: html
configuration: docs/conf.py
fail_on_warning: true

formats:
- pdf
30 changes: 16 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Python package for NAIF WebGeoCalc API
======================================
🐍 Python package for NAIF WebGeoCalc API
=========================================

|Docs| |Build| |Coverage| |CodeFactor|

Expand Down Expand Up @@ -47,8 +47,8 @@ calculations through this API.
.. _Documentation: https://wgc2.jpl.nasa.gov:8443/webgeocalc/documents/api-info.html
.. _`JavaScript examples`: https://wgc2.jpl.nasa.gov:8443/webgeocalc/example/perform-calculation.html

Note the user
-------------
⚠️ Caution
----------

`WebGeoCalc`_ is not design to handle heavy calculation.
If you need to make intensive queries, use `Spiceypy`_ or `SpiceMiner`_
Expand All @@ -59,17 +59,17 @@ Note the user
.. _`SpiceMiner`: https://github.com/DaRasch/spiceminer


Install
-------
📦 Install
----------
With ``pip``:

.. code:: bash

$ pip install webgeocalc


Usage
-----
🚀 Usage
--------

.. code:: python

Expand Down Expand Up @@ -155,8 +155,9 @@ More details can be found in the `docs`_ and in the `Jupyter Notebooks`_.
.. _`docs`: https://webgeocalc.readthedocs.io/en/stable/calculation.html
.. _`Jupyter Notebooks`: https://nbviewer.jupyter.org/github/seignovert/python-webgeocalc/blob/main/examples/calculation.ipynb

Command Line Interface (cli)
----------------------------

⚙️ Command Line Interface (cli)
-------------------------------

The webgeocalc API can be call directly from the command line interface:

Expand Down Expand Up @@ -212,8 +213,8 @@ More examples can be found in here_.
.. _here: https://webgeocalc.readthedocs.io/en/stable/cli.html


Local development and testing
-----------------------------
🧪 Local development and testing
--------------------------------

Setup:

Expand Down Expand Up @@ -244,7 +245,8 @@ Docs:
sphinx-build docs docs/_build --color -W -bdoctest


Disclaimer
----------
📣 Disclaimer
-------------

This project is not supported or endorsed by either JPL, NAIF or NASA.
The code is provided *"as is"*, use at your own risk.
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ and can be retrieved directly as items:
'WGC2 -- a WebGeocalc Server with enabled API at NAIF, JPL'

>>> API['version']
'2.7.6'
'2.8.2'


Request kernel sets
Expand Down
Loading