search

opera-adt / COMPASS

COregistered Multi-temPorAl Sar Slc
Apache License 2.0
38 stars 18 forks source link

Attempt to pin the reqs and add mambaforge for docs build #170

Closed scottstanie closed 1 year ago

scottstanie commented 1 year ago

Trying again to have the PR docs build now that I've turned on that setting.

scottstanie commented 1 year ago

Whew finally, https://opera-compass--170.org.readthedocs.build/en/170/

The main change that I did simply to make it as uniform with the Dolphin docs was to move the metadata from setup.cfg into pyproject.toml. I did this so we could do pip install .[docs]:

(mapping) staniewi:COMPASS$ pip install -e .[docs]
Obtaining file:///Users/staniewi/repos/COMPASS
  Installing build dependencies ... done
  Checking if build backend supports build_editable ... done
  Getting requirements to build editable ... done
  Installing backend dependencies ... done
  Preparing editable metadata (pyproject.toml) ... done
Requirement already satisfied: pymdown-extensions in /Users/staniewi/miniconda3/envs/mapping/lib/python3.10/site-packages (from compass==0.3.1) (9.9)
Requirement already satisfied: mkdocs in /Users/staniewi/miniconda3/envs/mapping/lib/python3.10/site-packages (from compass==0.3.1) (1.4.2)
...
Requirement already satisfied: six>=1.5 in /Users/staniewi/miniconda3/envs/mapping/lib/python3.10/site-packages (from python-dateutil>=2.8.1->ghp-import>=1.0->mkdocs->compass==0.3.1) (1.16.0)
Building wheels for collected packages: compass
  Building editable for compass (pyproject.toml) ... done
  Created wheel for compass: filename=compass-0.3.1-0.editable-py3-none-any.whl size=7215 sha256=02d5afa67bc2787491cde9c1cddb809aa9ca6b60b9166acc4aad8cf7af36ec7c
  Stored in directory: /private/var/folders/hw/sj9hl8555s36n00t812twvcr0000gq/T/pip-ephem-wheel-cache-jzpq879x/wheels/e6/56/25/f3813609fca72c9fa490615207bc3d50c6f26da5cb087b2971
Successfully built compass
Installing collected packages: compass
  Attempting uninstall: compass
    Found existing installation: compass 0.3.1
    Uninstalling compass-0.3.1:
      Successfully uninstalled compass-0.3.1
Successfully installed compass-0.3.1

I'm sure there's a way to do it differently than how i solved the docs building/requirements problem, so if you feel strongly about keeping a setup.cfg, let me know.

vbrancat commented 1 year ago

@LiangJYu can you review this PR? Merci