Updates on ipyleaflet documentation #953

HaudinFlorence · 2022-04-01T13:50:21Z

use autodoc to replace the attributes and methods tables of the documentation by the autogeneration using docstrings
write the docstrings of velocity.Velocity class
add a page named API reference page for the leaflet module
add changes to homogenize the structure/names of the sections of the different pages

Fix #915

docs/res.txt

docs/source/api_reference/map.rst

docs/test.wkt

ipyleaflet/leaflet.py

res.txt

martinRenou · 2022-04-01T14:03:11Z

Thanks a lot! This is great.

The ReadTheDocs build fails because it's missing yarn, you should probably remove the requirements.txt file and replace it with and environment.yml file containing:

name: ipyleaflet-docs

channels:
  - conda-forge

dependencies:
  - yarn
  - jupyterlab
  - jupyter-packaging
  - jupyter-sphinx
  - scipy
  - netcdf4
  - geopandas
  - xarray
  - branca
  - shapely
  - pip:
    - .

martinRenou · 2022-04-01T14:23:06Z

You will also need to change the readthedocs config file according to https://docs.readthedocs.io/en/latest/guides/conda.html#making-builds-faster-with-mamba in order to use mamba

.readthedocs.yaml

use autodoc to replace the attributes and methods tables of the documentation by the autogeneration using docstrings write the docstrings of velocity.Velocity class add a page named API reference page for the leaflet module add changes to homogenize the structure/names of the sections of the different pages

martinRenou

This is looking great thanks!