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

Adding missing rst for new files #102

Merged
merged 7 commits into from
Nov 6, 2023
Merged

Adding missing rst for new files #102

merged 7 commits into from
Nov 6, 2023

Conversation

PaulWessel
Copy link
Member

Also adding images and logos.

Also adding images and logos.
@PaulWessel PaulWessel added the documentation Improvements or additions to documentation label Nov 5, 2023
@PaulWessel PaulWessel self-assigned this Nov 5, 2023
Copy link
Contributor

github-actions bot commented Nov 5, 2023

Images automagically compressed by Calibre's image-actions

Compression reduced images by 48.5%, saving 67.63 KB.

Filename Before After Improvement Visual comparison
docs/_static/cnes.jpg 109.51 KB 48.34 KB -55.9% View diff
docs/_static/usgs.png 29.94 KB 23.48 KB -21.6% View diff

32 images did not require optimisation.

Update required: Update image-actions configuration to the latest version before 1/1/21. See README for instructions.

@PaulWessel
Copy link
Member Author

Should mention that I get this build error:

reading sources... [100%] index
/Users/pwessel/UH/RESEARCH/CVSPROJECTS/GMTdev/remote-datasets/docs/index.rst:13: ERROR: Invalid directive argument: argument must be 1 or 4 (xs sm md lg) values, and each value should be either auto or an integer from 1 to 12

Maybe @seisman knows that to do?

Copy link
Member

@Esteban82 Esteban82 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that they are ok. I make a commit to delete extra white space and fix a typo.

@seisman
Copy link
Member

seisman commented Nov 5, 2023

I see more warnings:

/Users/seisman/OSS/gmt/remote-datasets/docs/earth-edefl.rst:: WARNING: image file not readable: _static/GMT_earth_edefl.jpg
/Users/seisman/OSS/gmt/remote-datasets/docs/earth-faaerror.rst:: WARNING: duplicate label tbl-earth_faa, other instance in /Users/seisman/OSS/gmt/remote-datasets/docs/earth-faa.rst
/Users/seisman/OSS/gmt/remote-datasets/docs/earth-faaerror.rst:: WARNING: image file not readable: _static/GMT_earth_faaerror.jpg
/Users/seisman/OSS/gmt/remote-datasets/docs/earth-gebco.rst:: WARNING: image file not readable: _static/GMT_earth_gebco.jpg
/Users/seisman/OSS/gmt/remote-datasets/docs/earth-mag.rst:: WARNING: image file not readable: _static/GMT_earth_mag.jpg
/Users/seisman/OSS/gmt/remote-datasets/docs/earth-mdt.rst:: WARNING: image file not readable: _static/GMT_earth_mdt.jpg
/Users/seisman/OSS/gmt/remote-datasets/docs/earth-ndefl.rst:2: WARNING: Title underline too short.

IGPP Earth South-North Deflections
--------------------------------
/Users/seisman/OSS/gmt/remote-datasets/docs/earth-ndefl.rst:: WARNING: image file not readable: _static/GMT_earth_ndefl.jpg
/Users/seisman/OSS/gmt/remote-datasets/docs/index.rst:13: ERROR: Invalid directive argument: argument must be 1 or 4 (xs sm md lg) values, and each value should be either auto or an integer from 1 to 12
/Users/seisman/OSS/gmt/remote-datasets/docs/index.rst:137: WARNING: duplicated entry found in toctree: earth-faa
/Users/seisman/OSS/gmt/remote-datasets/docs/index.rst:137: WARNING: duplicated entry found in toctree: earth-gebco
/Users/seisman/OSS/gmt/remote-datasets/docs/index.rst:137: WARNING: duplicated entry found in toctree: earth-mask
/Users/seisman/OSS/gmt/remote-datasets/docs/index.rst:137: WARNING: duplicated entry found in toctree: earth-relief
/Users/seisman/OSS/gmt/remote-datasets/docs/index.rst:137: WARNING: duplicated entry found in toctree: earth-daynight
/Users/seisman/OSS/gmt/remote-datasets/docs/venus-relief.rst:2: WARNING: Title underline too short.

NASA Venus Relief
----------------
looking for now-outdated files... none found
pickling environment... done
checking consistency... /Users/seisman/OSS/gmt/remote-datasets/docs/earth-ndefl.rst: WARNING: document isn't included in any toctree
/Users/seisman/OSS/gmt/remote-datasets/docs/mars-relief.rst: WARNING: document isn't included in any toctree
/Users/seisman/OSS/gmt/remote-datasets/docs/mercury-relief.rst: WARNING: document isn't included in any toctree
/Users/seisman/OSS/gmt/remote-datasets/docs/moon-relief.rst: WARNING: document isn't included in any toctree
/Users/seisman/OSS/gmt/remote-datasets/docs/pluto-relief.rst: WARNING: document isn't included in any toctree
/Users/seisman/OSS/gmt/remote-datasets/docs/venus-relief.rst: WARNING: document isn't included in any toctree

@PaulWessel
Copy link
Member Author

I think I got split across two PRs... If #101 is approved then this one should have fewer issues?

@PaulWessel
Copy link
Member Author

Now I only get

/Users/pwessel/UH/RESEARCH/CVSPROJECTS/GMTdev/remote-datasets/docs/index.rst:13: ERROR: Invalid directive argument: argument must be 1 or 4 (xs sm md lg) values, and each value should be either auto or an integer from 1 to 12

Not sure what the args to grid: means.

@seisman
Copy link
Member

seisman commented Nov 5, 2023

Now I only get

/Users/pwessel/UH/RESEARCH/CVSPROJECTS/GMTdev/remote-datasets/docs/index.rst:13: ERROR: Invalid directive argument: argument must be 1 or 4 (xs sm md lg) values, and each value should be either auto or an integer from 1 to 12

Not sure what the args to grid: means.

Similar to my changes in 6b49a29, be careful with the indents.

@PaulWessel
Copy link
Member Author

I tried different spaces etc but cannot get it to work.

@seisman
Copy link
Member

seisman commented Nov 6, 2023

I tried different spaces etc but cannot get it to work.

I've fixed it, now the only warning is:

remote-datasets/docs/index.rst:: WARNING: image file not readable: _static/GMT_earth_mag4km_thumbnail.jpg

@PaulWessel
Copy link
Member Author

That should just be mag, not mag4k.

@PaulWessel PaulWessel merged commit 2f7840f into main Nov 6, 2023
3 checks passed
@PaulWessel PaulWessel deleted the more-datasets branch November 6, 2023 08:06
@Esteban82
Copy link
Member

I have a doubt. Why the mars relief is credit to the NASA while the others planets relief (like moon) to the USGS?

From the recipe, the source seems to be USGS.

# SRC_FILE=https://planetarymaps.usgs.gov/mosaic/Mars/HRSC_MOLA_Blend/Mars_HRSC_MOLA_BlendDEM_Global_200mp_v2.tif

@PaulWessel
Copy link
Member Author

Well, NASA collected the data I think but sometimes they both contribute to the final product. @WalterHFSmith might know what we should do, say both logos.

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.

3 participants