Skip to content

Commit

Permalink
Include project docs in package documentation
Browse files Browse the repository at this point in the history
This includes the license, code of conduct, and contributing docs.
  • Loading branch information
mdpiper committed Mar 27, 2024
1 parent d6bf420 commit 76db5ca
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/source/CODE-OF-CONDUCT.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Code of Conduct
===============

Everyone participating in this project is governed by the CSDMS `Code of
Conduct <https://github.com/csdms/project/blob/main/CODE-OF-CONDUCT.md>`__.
By participating, you are expected to uphold this code.
8 changes: 8 additions & 0 deletions docs/source/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Contributing
============

We welcome, and greatly appreciate, contributions to `CSDMS
Workbench <https://csdms.colorado.edu/wiki/Workbench>`__ tools. For
recommendations on how you can contribute, please see the CSDMS project
`CONTRIBUTING <https://github.com/csdms/project/blob/main/CONTRIBUTING.md>`__
document.
23 changes: 23 additions & 0 deletions docs/source/LICENSE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
MIT License
===========

Copyright (c) 2021 Community Surface Dynamics Modeling System

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
“Software”), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
4 changes: 3 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ Project documents
.. toctree::
:maxdepth: 2

license
LICENSE
CODE-OF-CONDUCT
CONTRIBUTING

Indices and tables
..................
Expand Down
1 change: 0 additions & 1 deletion docs/source/license.rst

This file was deleted.

2 changes: 1 addition & 1 deletion noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ def format(session: nox.Session) -> None:
def prepare_docs(session: nox.Session) -> None:
"""Update docs source before building."""
session.run("sphinx-apidoc", "-f", "-o", "docs/source/api", PACKAGE)
for file in ["README", "CHANGES"]:
for file in ["README", "CHANGES", "CONTRIBUTING", "CODE-OF-CONDUCT", "LICENSE"]:
session.run(
"pandoc", "--to", "rst", f"{file}.md", "--output", f"docs/source/{file}.rst"
)
Expand Down

0 comments on commit 76db5ca

Please sign in to comment.