Skip to content

Commit d779136

Browse files
Meghan Jonesseisman
Meghan Jones
and
seisman
authored
Add a sphinx docs structure for hosting gmt examples (#1)
* Add CC-BY-4.0 License * Add short description * Add environment.yml * Add .gitignore * Add requirements.txt * Add vercel.json * Setup sphinx documentation for gmt-examples * Add workflow for deploying docs * Add package.json for continuous documentation * Add contributors guide and code of conduct * Add pip instructions * Add links to sections * Apply suggestions from code review Co-authored-by: Dongdong Tian <[email protected]> * Update copyright, author, and add authors guideline * Move gallery and tutorials dirs under docs * Set default highlight language * Remove myst-parser dependency * Move up examples overview section * Add description of dependencies * Add note about Python environment * Apply suggestions from code review Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>
1 parent 651e018 commit d779136

24 files changed

+1248
-0
lines changed

‎.github/workflows/docs.yml

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
#
2+
# Build documentation and deploy
3+
#
4+
name: Docs
5+
6+
on:
7+
# pull_request:
8+
push:
9+
branches:
10+
- main
11+
paths:
12+
- 'docs/**'
13+
- '.github/workflows/**'
14+
15+
jobs:
16+
build:
17+
runs-on: ubuntu-20.04
18+
defaults:
19+
run:
20+
shell: bash -l {0}
21+
22+
steps:
23+
# Checks-out your repository under $GITHUB_WORKSPACE
24+
- name: Checkout
25+
uses: actions/[email protected]
26+
27+
# Install Mambaforge with conda-forge dependencies
28+
- name: Setup Mambaforge
29+
uses: conda-incubator/[email protected]
30+
with:
31+
activate-environment: gmt-examples
32+
environment-file: environment.yml
33+
python-version: 3.8
34+
channels: conda-forge,nodefaults
35+
channel-priority: strict
36+
miniforge-version: latest
37+
miniforge-variant: Mambaforge
38+
mamba-version: "*"
39+
use-mamba: true
40+
41+
# Show installed pkg information for postmortem diagnostic
42+
- name: List installed packages
43+
run: mamba list
44+
45+
- name: Build the website
46+
run: make -C docs clean html
47+
48+
- name: Deploy to gh-pages
49+
if: success() && github.event_name == 'push'
50+
# Don't use tags: https://julienrenaux.fr/2019/12/20/github-actions-security-risk/
51+
uses: peaceiris/actions-gh-pages@bbdfb200618d235585ad98e965f4aafc39b4c501
52+
with:
53+
github_token: ${{ secrets.GITHUB_TOKEN }}
54+
publish_dir: ./docs/_build/html/
55+
# Only keep the latest commit to avoid bloating the repository
56+
force_orphan: true
57+
user_name: 'github-actions[bot]'
58+
user_email: 'github-actions[bot]@users.noreply.github.com'

‎.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Sphinx documentation
2+
docs/_build/
3+
4+
# Visual Studio Code
5+
.vscode/
6+
7+
# Environments
8+
.env
9+
10+
# Backup copies / swap files
11+
*~
12+
.*.swp
13+
14+
# macOS
15+
.DS_Store

‎CODE_OF_CONDUCT.md

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
# Contributor Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
``pwessel at hawaii dot edu``, ``leouieda at gmail dot com``, or
64+
``meghanj at hawaii dot edu``. All complaints will be reviewed and investigated
65+
promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
127+
at [https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations

‎CONTRIBUTING.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing Guidelines
2+
3+
:tada: **First off, thank you for considering contributing to our project!** :tada:
4+
5+
This is a community-driven project, so it's people like you that make it useful and
6+
successful.
7+
These are some of the many ways to contribute:
8+
9+
* :bug: Submitting bug reports and feature requests
10+
* :memo: Writing tutorials or examples
11+
* :mag: Fixing typos and improving the documentation
12+
* :people_holding_hands: Community engagement and outreach
13+
14+
If you get stuck at any point you can create an
15+
[issue](https://github.com/GenericMappingTools/gmt-examples/issues) on GitHub or
16+
get in touch through the [GMT Forum](https://forum.generic-mapping-tools.org/).
17+
18+
For more information on contributing to open source projects,
19+
[GitHub's own guide](https://opensource.guide/how-to-contribute)
20+
is a great starting point if you are new to version control.
21+
22+
Detailed instructions for contributors to the GMT Examples project can be found
23+
in the [contributors guide](https://www.generic-mapping-tools.org/gmt-examples/contributing.html).
24+
25+
## Ground Rules
26+
27+
The goal is to maintain a diverse community that's pleasant for everyone.
28+
**Please be considerate and respectful of others**.
29+
Everyone must abide by our [Code of Conduct](CODE_OF_CONDUCT.md) and we encourage all to
30+
read it carefully.
31+
32+
## The `AUTHORS.md` file
33+
34+
Anyone who has contributed a pull request to the project is welcome to add
35+
themselves to the `AUTHORS.md` file.

0 commit comments

Comments
 (0)