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

Update docs related to NOAA CSPs #3043

Open
wants to merge 49 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
5590d86
Start working on improve CSP docs
weihuang-jedi Oct 21, 2024
a1e7fb4
update login info
weihuang-jedi Oct 21, 2024
61959bc
update login images
weihuang-jedi Oct 21, 2024
edc2e93
update login images
weihuang-jedi Oct 21, 2024
d2b78a4
Fork instance
weihuang-jedi Oct 21, 2024
99712fa
update instance images
weihuang-jedi Oct 21, 2024
e868bf7
add lustre
weihuang-jedi Oct 22, 2024
6269123
using cluster
weihuang-jedi Oct 22, 2024
a9a30c0
typo fix
weihuang-jedi Oct 22, 2024
9f22fa1
typo and spelling
weihuang-jedi Oct 28, 2024
d77d645
split code paragraph
weihuang-jedi Oct 28, 2024
9bdb50a
split code paragraph
weihuang-jedi Oct 28, 2024
52e7a82
Merge branch 'develop' of github.com:NOAA-EPIC/global-workflow-cloud …
weihuang-jedi Nov 4, 2024
6ca8507
mor eaccurate description of data
weihuang-jedi Nov 4, 2024
a05ff9d
remove unused PNGs
weihuang-jedi Nov 5, 2024
459a3ba
remove unused PNGs
weihuang-jedi Nov 5, 2024
a35a2e3
add a missed lustre PNG
weihuang-jedi Nov 5, 2024
51f3faa
lustre 5.PNG is not needed
weihuang-jedi Nov 5, 2024
634a6f0
double check to make sure Gillian's commends and suggestions are in
weihuang-jedi Nov 5, 2024
f6d0b47
double check to make sure Gillian's commends and suggestions are in
weihuang-jedi Nov 5, 2024
9751f2b
trying to fix the figure reference issue
weihuang-jedi Nov 5, 2024
9899397
fix a typo in png links
weihuang-jedi Nov 5, 2024
e9dddc2
adjust the code paragraph
weihuang-jedi Nov 5, 2024
94b781e
adjust the code paragraph
weihuang-jedi Nov 5, 2024
64c73cb
adjust the code paragraph
weihuang-jedi Nov 5, 2024
3771140
enable image num-ref
weihuang-jedi Nov 5, 2024
f166a18
enable image num-ref
weihuang-jedi Nov 5, 2024
ea4114c
make image reference
weihuang-jedi Nov 5, 2024
a2d64c8
make image reference
weihuang-jedi Nov 5, 2024
02e1605
make image reference
weihuang-jedi Nov 5, 2024
c9e7cfc
make image reference
weihuang-jedi Nov 5, 2024
d36c794
make image reference
weihuang-jedi Nov 5, 2024
9099ec3
make image reference
weihuang-jedi Nov 5, 2024
a0868d1
add wave.rst to index.rst
weihuang-jedi Nov 5, 2024
f39ed6a
testing numref
weihuang-jedi Nov 7, 2024
fb605f7
try to add caption to images
weihuang-jedi Nov 12, 2024
1e407a9
Merge branch 'develop' of github.com:NOAA-EPIC/global-workflow-cloud …
weihuang-jedi Nov 12, 2024
3dea381
try to add caption to images
weihuang-jedi Nov 12, 2024
b99e40a
try to add caption to images
weihuang-jedi Nov 12, 2024
907c5bb
Add caption and numerate figures
weihuang-jedi Nov 12, 2024
f5c485a
remove testing code
weihuang-jedi Nov 12, 2024
1f6b592
add a blank line to make the numerated list work
weihuang-jedi Nov 13, 2024
348884b
use auto numerated list
weihuang-jedi Nov 13, 2024
0c68ed2
use auto numerated list
weihuang-jedi Nov 13, 2024
4ce9697
use auto numerated list
weihuang-jedi Nov 13, 2024
f13082e
use auto numerated list and code-block
weihuang-jedi Nov 13, 2024
188d074
use auto numerated list and code-block
weihuang-jedi Nov 13, 2024
82bf411
use auto numerated list and code-block
weihuang-jedi Nov 13, 2024
5811c0a
reverse a change in confy.py
weihuang-jedi Nov 13, 2024
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
Binary file removed docs/source/_static/noaacsp_cluster_1.png
Binary file not shown.
Binary file removed docs/source/_static/noaacsp_cluster_2.png
Binary file not shown.
Binary file removed docs/source/_static/noaacsp_cluster_3.png
Binary file not shown.
Binary file removed docs/source/_static/noaacsp_cluster_4.png
Binary file not shown.
Binary file removed docs/source/_static/noaacsp_cluster_5.png
Binary file not shown.
Binary file removed docs/source/_static/noaacsp_cluster_6.png
Binary file not shown.
Binary file added docs/source/_static/noaacsp_filesystem_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_filesystem_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_filesystem_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_filesystem_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/noaacsp_instance_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/noaacsp_instance_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/noaacsp_instance_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/noaacsp_instance_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_login_1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_login_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_login_2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_login_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_lustre_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_lustre_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_lustre_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_lustre_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/noaacsp_using_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/noaacsp_using_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/noaacsp_using_3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
# The full version, including alpha/beta/rc tags
release = '0.1'

numfig = True
Copy link
Member

Choose a reason for hiding this comment

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

Curious, what is this being added for?

Choose a reason for hiding this comment

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

This enables the use of :numref:%s <target> syntax to refer to numbered items like tables, figures, and sections of the documentation. For some reason, we are still having trouble getting crosslinks to render using both :numref: and :ref:, and I have not had a chance to explore other reasons why that might be, but this line is definitely required for :numref: to work, in addition to whatever other changes may be required.

Copy link
Member

Choose a reason for hiding this comment

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

Gotcha, thanks for explaining that @gspetro-NOAA !


# -- General configuration ---------------------------------------------------

Expand Down Expand Up @@ -120,3 +121,4 @@ def setup(app):

# Output file base name for HTML help builder.
htmlhelp_basename = 'Global-Workflow'

1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,6 @@ Table of Contents
hpc.rst
output.rst
run.rst
wave.rst
noaa_csp.rst
errors_faq.rst
418 changes: 302 additions & 116 deletions docs/source/noaa_csp.rst

Large diffs are not rendered by default.

Loading