Restructure documentation and add new sections#525
Conversation
Documentation was reorganized into new sections: data sources, utilities, workflows, and advanced stress packages. Example notebooks were moved to corresponding subfolders, and new .rst files were added for each section. A new notebook on meteorological data was added. The index.rst was updated to reflect the new structure. Metadata in several notebooks was cleaned up, and a script to clear notebook outputs was introduced.
Expanded the list of available data sources in the documentation for greater clarity. Moved cache_example.py from docs/examples to docs/utilities for better organization.
Revised several documentation notebooks to improve clarity, update code, and remove author credits and images. Added a new workflow notebook for aggregating surface water features into model cells (taken from surface-water-notebook). Updated example and utility notebooks for consistency and improved instructions. Adjusted references to model workspace paths and improved section headings in meteorological data documentation.
Refactored example and workflow notebooks to remove unused script_path arguments from function calls and cleaned up markdown formatting. Updated kernelspec and language_info metadata in relevant notebooks. Minor improvements to documentation text for clarity.
|
I think I have fixed all the errors and added a new logo. This PR is ready for review. |
|
I removed all names and dates from the notebooks, as well as the logo of Artesia, as I think it looks better without. In the main page of the documentation, I added the logo of Artesia. |
docs/getting_started.rst
Outdated
| Getting Python | ||
| -------------- | ||
| To install nlmod, a working version of Python 3.7 or higher has to be | ||
| To install `nlmod`, a working version of Python 3.7 or higher has to be |
There was a problem hiding this comment.
Probably good to modify Python 3.7 to something a little more recent.
docs/data_sources.rst
Outdated
| - Landuse data from BGT, BRT or BRP | ||
| - Meteorological data from KNMI or Meteobase | ||
| - Waterboard data from each of the 21 waterboards | ||
| - Soil phisical units map from BOFEK |
There was a problem hiding this comment.
Section header levels are a bit weird. I think all below the title should be level 2, i.e. ##
There was a problem hiding this comment.
the bullet points under create model header are not correctly rendered.
There was a problem hiding this comment.
bullet points under Download data are not rendered correctly.
There was a problem hiding this comment.
nlmod.sim.ims can auto register the solution package if the model is passed as well: nlmod.sim.ims(sim, pname="ims_gwt", model=gwt)
There was a problem hiding this comment.
Did not change anything, as I am not sure what to do exactly
There was a problem hiding this comment.
structured grid has 3x3 cells not 10x10?
There was a problem hiding this comment.
bulleted list not rendering correctly
There was a problem hiding this comment.
Some rendering of code in model cells not so pretty?
dbrakenhoff
left a comment
dbrakenhoff
left a comment
There was a problem hiding this comment.
I ran through the example notebooks and found some stuff not rendering as intended.
For the rest, a really nice improvement to the documentation!
…een lines in code blocks" This reverts commit 51670ee.
Set nb_merge_streams to True in Sphinx configuration to merge output streams during notebook execution.
Added a noop implementation for tqdm and monkey-patched common variants in docs/conf.py to prevent progress bars from appearing during documentation builds.
Introduces a custom.css file to make pandas DataFrames horizontally scrollable in documentation. Updates conf.py to include the new CSS and switches TQDM disabling to use an environment variable for cleaner configuration.
2 participants
Documentation was reorganized into new sections:
Example notebooks were moved to corresponding subfolders, and new .rst files were added for each section. A new notebook on meteorological data was added. The index.rst was updated to reflect the new structure. Metadata in several notebooks was cleaned up, and a script to clear notebook outputs was introduced.