diff --git a/docs/conf.py b/docs/conf.py index df32994f..a84eefa7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,7 +40,11 @@ 'sphinx.ext.mathjax', 'sphinx_copybutton', 'sphinxcontrib.bibtex', - 'sphinxcontrib.srclinks'] + 'sphinxcontrib.srclinks', + 'sphinx.ext.graphviz'] + +# -- GraphViz configuration ---------------------------------- +graphviz_output_format = 'svg' copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " copybutton_prompt_is_regexp = True @@ -59,7 +63,7 @@ # General information about the project. project = 'Pangeo' -copyright = '2018-2021, Pangeo Team' +copyright = '2018-2022, Pangeo Team' author = 'Pangeo Team' # The version info for the project you're documenting, acts as replacement for @@ -115,7 +119,7 @@ # an arbitrary url. 'navbar_links': [ ("Blog", "https://medium.com/pangeo", True), - ("Forum", "https://discourse.pangeo.io", True), + ("Discourse Forum", "https://discourse.pangeo.io", True), ], } diff --git a/docs/index.rst b/docs/index.rst index 31361db7..14600c70 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,8 +9,53 @@ Pangeo .. image:: _static/pangeo_simple_logo.svg :width: 175 px -A community platform for Big Data geoscience -============================================ +A community promoting open, reproducible, and scalable geoscience +================================================================= + +.. list-table:: + :widths: 10 10 10 10 10 + :header-rows: 1 + :align: left + + * - ❓ Have questions about Python software? + - 🤩 Want to hear about new updates to Pangeo software or infrastructure? + - 😃 Wondering how you can get involved in the Pangeo community? + - ☁️ Interested in getting access to Pangeo Cloud? + - 🧐 Just curious to learn more about Pangeo? + * - Search for answers or ask your own question on the `Pangeo Discourse Forum `_! + - Check out our `Medium blog `_ and our `Twitter feed `_! + - Post or answer questions in the `Pangeo Discourse Forum `_, attend a `community meeting `_, or start issues/create pull requests on our `GitHub repos `_! + - Fill out the application form available on the `Pangeo Cloud site `_. + - Read about us on the `About Pangeo page `_. + +.. + This portion is currently commented out rather than deleted, because it appears that the "toctree" here may be + necessary for the website (currently generates many errors). See note at top. + +.. Contents +.. ^^^^^^^^ + +.. +.. + .. toctree:: +.. :maxdepth: 1 + +.. about +.. faq +.. quickstart +.. packages +.. gallery +.. architecture +.. setup_guides/index +.. cloud +.. data +.. catalog +.. collaborators +.. publications +.. pangeo-showcase +.. meeting-notes +.. meetings/index +.. contact .. image:: https://img.shields.io/github/contributors/pangeo-data/pangeo?logo=github&style=flat-square :target: https://github.com/pangeo-data/pangeo @@ -24,88 +69,3 @@ A community platform for Big Data geoscience .. image:: https://img.shields.io/twitter/follow/pangeo_data?logo=twitter&style=flat-square :target: https://twitter.com/pangeo_data :alt: Twitter - -This website contains general information about the Pangeo project. -For news and updates about Pangeo, check out our -`Medium blog `_ and our -`Twitter feed `_. -To engage with the Pangeo community, head over to our -`Discourse forum `_ -or browse our `GitHub repos `_. - - -.. raw:: html - -
-
-

Twitter Feed

-

We use twitter to share announcements and retweet content of interest to our community.

- -
-
-

Discourse Forum

-

Discourse is a message board where we discuss all aspects of the project in a friendly, inclusive way.

-
- - -
-
- -What is Pangeo? -=============== - -Pangeo is first and foremost a community promoting open, reproducible, and scalable science. -This community provides documentation, develops and maintains software, and deploys -computing infrastructure to make scientific research and programming easier. -The Pangeo software ecosystem involves -open source tools such as xarray, iris, dask, jupyter, and many other packages. -There is no single software package called "pangeo"; rather, the Pangeo project serves -as a coordination point between scientists, software, and computing infrastructure. -On this website, scientists can find guides for accessing data and performing analysis -using these tools (read the :ref:`quickstart`, browse the :ref:`use-cases`, and -learn about the :ref:`packages`). -Those interested in building infrastructure can find -instructions for deploying Pangeo environments on HPC or cloud clusters -(learn about the :ref:`architecture` or read the :ref:`setup-guides`). -For more general information, read :ref:`about`, see the :ref:`collaborators`, -or read the :ref:`FAQ`. -Welcome to the Pangeo community! - -Our Goals -^^^^^^^^^ - -#. Foster collaboration around the open source scientific python ecosystem for - ocean / atmosphere / land / climate science. -#. Support the development with domain-specific geoscience packages. -#. Improve scalability of these tools to handle petabyte-scale datasets on - HPC and cloud platforms. - -Pangeo Gallery -^^^^^^^^^^^^^^ - -Science applications and detailed tutorial for using Pangeo can be found in -`Pangeo Gallery `_. - - -Contents -^^^^^^^^ - -.. toctree:: - :maxdepth: 1 - - about - faq - quickstart - packages - gallery - architecture - setup_guides/index - cloud - data - catalog - collaborators - publications - pangeo-showcase - meeting-notes - meetings/index - contact