Skip to content

Commit c8aa46a

Browse files
committed
docs: Add README.md and _config.yml
1 parent a48e8e0 commit c8aa46a

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

docs/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Building TSMP-PDAF Documentation
2+
3+
If you'd like to develop and/or build the eCLM documentation, you should:
4+
5+
1. Switch to this directory: `cd docs`
6+
2. Run `pip install -r requirements.txt`
7+
3. (*Optional*) Edit the books source files (`*.md`) in this folder. Check out the [MyST syntax cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html) for reference.
8+
4. Build the docs: `make clean docs`.
9+
5. (*Optional*) Build eCLM source code browser: `make src-browser`
10+
6. Launch the doc homepage on your default browser: `open _build/html/index.html`
11+
12+
## Contributors
13+
14+
We welcome and recognize all contributions. You can see a list of current contributors in the [contributors tab](https://github.com/HPSCTerrSys/pdaf/graphs/contributors).
15+
16+
## Credits
17+
18+
This project is created using the excellent open source [Jupyter Book project](https://jupyterbook.org/) and the [executablebooks/cookiecutter-jupyter-book template](https://github.com/executablebooks/cookiecutter-jupyter-book).

docs/_config.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
#######################################################################################
2+
# A default configuration that will be loaded for all jupyter books
3+
# See the documentation for help and more options:
4+
# https://jupyterbook.org/customize/config.html
5+
6+
#######################################################################################
7+
# Book settings
8+
title : TSMP-PDAF Documentation # The title of the book. Will be placed in the left navbar.
9+
author : HPSC TerrSys # The author of the book
10+
copyright : "2025" # Copyright year to be placed in the footer
11+
logo : "" # A path to the book logo
12+
13+
# Force re-execution of notebooks on each build.
14+
# See https://jupyterbook.org/content/execute.html
15+
execute:
16+
execute_notebooks: force
17+
18+
# Define the name of the latex output file for PDF builds
19+
latex:
20+
latex_documents:
21+
targetname: book.tex
22+
23+
sphinx:
24+
config:
25+
language: en
26+
27+
# Information about where the book exists on the web
28+
repository:
29+
url: https://github.com/HPSCTerrSys/pdaf # Online location of your book
30+
path_to_book: docs # Optional path to your book, relative to the repository root
31+
branch: master # Which branch of the repository should be used when creating links (optional)
32+
33+
# Add GitHub buttons to your book
34+
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
35+
html:
36+
use_issues_button: true
37+
use_repository_button: true
38+
39+
# Do not parse these files
40+
exclude_patterns: [FORD_options.md, FORD_options_int.md, README.md]

0 commit comments

Comments
 (0)