Skip to content

Commit

Permalink
Reorganize sections.
Browse files Browse the repository at this point in the history
  • Loading branch information
ioannis-vm committed Aug 18, 2024
1 parent 85ffd70 commit 445a726
Show file tree
Hide file tree
Showing 13 changed files with 88 additions and 117 deletions.
36 changes: 31 additions & 5 deletions doc/source/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,7 +1,33 @@
html {
--pst-font-family-base: Montserrat, var(--pst-font-family-base-system);
--pst-font-size-base: 17px;
--pst-font-family-heading: Palatino, var(--pst-font-family-base-system);
--pst-font-family-monospace: Courier, var(--pst-font-family-monospace-system);
wy-nav-content {
max-width: none;
}


.math {
text-align: left;
}

.eqno {
float: right;
}


#div.wy-side-scroll{
# background:#cb463f;
#}

div.wy-menu.wy-menu-vertical > .caption {
color: #cb463f;
}

# LIGHT BLUE background:#0099ff
# BLUE: background:#0B619C
# ADAM RED: background:#cb463f;

span.caption.caption-text{
color: #000000;
}

td{
white-space: normal !important;
}
19 changes: 8 additions & 11 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

html_css_files = ["css/custom.css"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
Expand Down Expand Up @@ -79,19 +86,9 @@
"logo_only": True,
"collapse_navigation": False,
"prev_next_buttons_location": None,
"navigation_depth": 2,
"style_nav_header_background": "#F2F2F2",
}

html_sidebars = {"examples/**": []}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = [
"css/custom.css",
]

html_show_sphinx = False # Removes "Built with Sphinx using a theme [...]"
html_show_sourcelink = (
False # Remove 'view source code' from top of page (for html, not python)
Expand Down
5 changes: 5 additions & 0 deletions doc/source/developer_guide/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
Welcome to the pelicun developer guide.
The following pages contain information on setting up a development environment, our code quality requirements, our code of conduct, and information on the submission process.
Thank you for your interest in extending pelicun.
We are looking forward to your contributions!

===============
Getting started
===============
Expand Down
19 changes: 0 additions & 19 deletions doc/source/developer_guide/index.rst

This file was deleted.

14 changes: 7 additions & 7 deletions doc/source/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. _examples:

********
Examples
********
*************
Example Index
*************

Pelicun examples are listed in the following index.

Expand All @@ -14,8 +14,8 @@ Pelicun examples are listed in the following index.
Increasing the set of examples is a very high priority.
Please come back soon!

Index
-----
Complete list
-------------

+-----------+---------------------------------------------------------+
|Example |Description |
Expand All @@ -37,8 +37,8 @@ Index
|E7 |... |
+-----------+---------------------------------------------------------+

Interested in a specific feature?
---------------------------------
Grouped by feature
------------------

The following sections group the examples above based on the specific features they illustrate, helping you pick the ones most relevant to what you are looking for.

Expand Down
File renamed without changes.
68 changes: 30 additions & 38 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,53 +14,45 @@ Pelicun is an open-source Python package for the probabilistic estimation of los
Community-driven, easy to use and extend, it serves as an integrated multi-hazard risk estimation framework for buildings and other infrastructure.
Utilized in both academia and industry, it supports cutting-edge natural hazards engineering research while helping spread the adoption of performance-based engineering in practical applications.

.. grid:: 1 2 2 2
:gutter: 4
:padding: 2 2 0 0
:class-container: sd-text-center

.. grid-item-card:: User Guide
:img-top: _static/front_page/book-svgrepo-com.svg
:class-card: intro-card
:shadow: md
:link: user_guide
:link-type: ref
.. toctree::
:caption: User Guide
:maxdepth: 1
:numbered: 4

Fundamental information on pelicun, including basic concepts, definition of terms, installation instructions, and how to get help.
user_guide/install
user_guide/pelicun_framework
user_guide/feature_overview
user_guide/input_specification
user_guide/damage_and_loss_library
user_guide/bug_reports_and_feature_requests
user_guide/resources_for_new_python_users

.. grid-item-card:: Examples
:img-top: _static/front_page/right-arrow-svgrepo-com.svg
:class-card: intro-card
:shadow: md
:link: examples
:link-type: ref
.. toctree::
:caption: Developer Guide
:maxdepth: 1
:numbered: 4

See pelicun's capabilities in action with illustrative and configurable usage examples involving a broad range of hazard and asset types.
developer_guide/getting_started
developer_guide/development_environment
developer_guide/code_quality
developer_guide/internals

.. grid-item-card:: Developer Guide
:img-top: _static/front_page/programmer-svgrepo-com.svg
:class-card: intro-card
:shadow: md
:link: developer_guide
:link-type: ref
.. toctree::
:caption: Examples
:maxdepth: 1

Important information for contributors, including information on setting up a development environment, our code quality requirements, and the submission process.
examples/index

.. grid-item-card:: API Reference
:img-top: _static/front_page/api-svgrepo-com.svg
:class-card: intro-card
:shadow: md
:link: api_reference
:link-type: ref
.. toctree::
:caption: API Reference
:maxdepth: 1

Browse the comprehensive documentation of the public classes, methods, and functions in pelicun.
api_reference/index.rst

.. toctree::
:caption: Other
:maxdepth: 1
:hidden:

user_guide/index
examples/index
developer_guide/index
api_reference/index.rst
release_notes/index.rst
other/license
other/cite
File renamed without changes.
4 changes: 2 additions & 2 deletions doc/source/user_guide/cite.rst → doc/source/other/cite.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _cite:

Citing Pelicun in Research Publications
---------------------------------------
Citing pelicun and pelicun logo
-------------------------------

.. admonition:: Coming soon.

Expand Down
File renamed without changes.
10 changes: 0 additions & 10 deletions doc/source/user_guide/brand_logo.rst

This file was deleted.

25 changes: 0 additions & 25 deletions doc/source/user_guide/index.rst

This file was deleted.

5 changes: 5 additions & 0 deletions doc/source/user_guide/install.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
.. _user_install:

Welcome to the pelicun user guide.
Below, you will find instructions on installing pelicun and information about the supported features, the basic concepts behind them, the terminology used, the expected inputs, and where to get help.
Join our growing community of users and developers dedicated to advancing risk estimation practices and sharing insights.


Getting started
---------------

Expand Down

0 comments on commit 445a726

Please sign in to comment.