Merge pull request #122 from SamGuay/master

[ENH, FIX] Update documentation based on #120

.github/workflows/publish_doc.yaml

@@ -0,0 +1,30 @@
+name: Publish documentation
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements-dev.txt ]; then pip install -r requirements-dev.txt; fi
+    - name: run portray
+      run: |
+        portray as_html
+    - name: Deploy to gh-pages branch
+      uses: peaceiris/[email protected]
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./site

.gitignore

@@ -133,3 +133,6 @@ tests/data/*
 !tests/data/config_test.json
 !tests/data/config_test_not_case_sensitive_option.json
 !tests/data/sidecars/*
+
+# dcm2bids documentation
+/site

CODE_OF_CONDUCT.md

@@ -2,50 +2,48 @@
 
 Each of us as a member of the dcm2bids community we ensure that every
 contributors enjoy their time contributing and helping people. Accordingly,
-
-everyone who participates in the development in any way possible is
- expected to show respect, courtesy to other community members including
- end-users who are seeking help on [Neurostars](https://neurostars.org/) or on [GitHub](https://github.com/UNFmontreal/Dcm2Bids/issues).
-
+everyone who participates in the development in any way possible is expected to
+show respect, courtesy to other community members including end-users who are
+seeking help on [Neurostars](https://neurostars.org/) or on
+[GitHub](https://github.com/UNFmontreal/Dcm2Bids/issues).
 
 We also encourage everybody regardless of age, gender identity, level of
-experience, nativa langage, race or religion to be involved in the project.
-We pledge to make participation in the dcm2bids project an harassment-free
+experience, native langage, race or religion to be involved in the project. We
+pledge to make participation in the dcm2bids project an harassment-free
 experience for everyone.
 
-
 ## Our standards
 
 We commit to promote any behavior that contributes to create a positive
- environment including:
-* Using welcoming and inclusive language
-* Being respectful
-* Show empathy towards everybody
-* Focusing on what is best for the community
+environment including:
+
+- Using welcoming and inclusive language;
+- Being respectful;
+- Show empathy towards everybody;
+- Focusing on what is best for the community.
 
 We do **NOT** tolerate harassment or inappropriate behavior in the dcm2bids
 community.
 
-
 ## Our responsibilities
 
 Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
 response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening,
+offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within our online GitHub repository
-and in public spaces when an individual is representing the project or its community.
-Examples of representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
+This Code of Conduct applies both within our online GitHub repository and in
+public spaces when an individual is representing the project or its community.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event.
 
 ## Enforcement
 
@@ -54,24 +52,24 @@ reported by contacting Arnaud Boré at <[email protected]>.
 
 Confidentiality will be respected in reporting.
 
-As the first interim [Benevolent Dictator for Life (BDFL)](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life), Arnaud Boré can take any action he deems
-appropriate for the safety of the dcm2bids community, including but not
-limited to:
-* facilitating a conversation between the two parties involved in the
-violation of the code of conduct
-* requesting a contributor apologize for their behavior
-* asking a contributor or multiple contributors to enter a cooling off period
- that puts a time-limited pause on a particular discussion topic
-* asking a contributor to no longer participate in the
-development of *dcm2bids*
+As the first interim
+[Benevolent Dictator for Life (BDFL)](https://en.wikipedia.org/wiki/Benevolent_dictator_for_life),
+Arnaud Boré can take any action he deems appropriate for the safety of the
+dcm2bids community, including but not limited to:
+
+- facilitating a conversation between the two parties involved in the violation
+  of the code of conduct;
+- requesting a contributor apologize for their behavior;
+- asking a contributor or multiple contributors to enter a cooling off period
+  that puts a time-limited pause on a particular discussion topic;
+- asking a contributor to no longer participate in the development of _dcm2bids_.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-as well as Code of Conduct from the [tedana][tedana-repo] and
-[STEMMRoleModels][stem-repo] projects.
+This Code of Conduct was adapted from the [Contributor Covenant][covenant-home],
+version 1.4, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct.html][covenant-coc] as well as Code of Conduct from the [tedana][tedana-repo] and [STEMMRoleModels][stem-repo] projects.
 
 [stem-repo]: https://github.com/KirstieJane/STEMMRoleModels
 [tedana-repo]: https://github.com/ME-ICA/tedana
-[homepage]: https://www.contributor-covenant.org/
+[covenant-home]: https://www.contributor-covenant.org/
+[covenant-coc]: https://www.contributor-covenant.org/version/1/4/code-of-conduct.html