From 76db5cad4e966aaa9c1061160d421f006d696456 Mon Sep 17 00:00:00 2001 From: Mark Piper Date: Wed, 27 Mar 2024 12:45:36 -0600 Subject: [PATCH] Include project docs in package documentation This includes the license, code of conduct, and contributing docs. --- docs/source/CODE-OF-CONDUCT.rst | 6 ++++++ docs/source/CONTRIBUTING.rst | 8 ++++++++ docs/source/LICENSE.rst | 23 +++++++++++++++++++++++ docs/source/index.rst | 4 +++- docs/source/license.rst | 1 - noxfile.py | 2 +- 6 files changed, 41 insertions(+), 3 deletions(-) create mode 100644 docs/source/CODE-OF-CONDUCT.rst create mode 100644 docs/source/CONTRIBUTING.rst create mode 100644 docs/source/LICENSE.rst delete mode 100644 docs/source/license.rst diff --git a/docs/source/CODE-OF-CONDUCT.rst b/docs/source/CODE-OF-CONDUCT.rst new file mode 100644 index 0000000..528ff21 --- /dev/null +++ b/docs/source/CODE-OF-CONDUCT.rst @@ -0,0 +1,6 @@ +Code of Conduct +=============== + +Everyone participating in this project is governed by the CSDMS `Code of +Conduct `__. +By participating, you are expected to uphold this code. diff --git a/docs/source/CONTRIBUTING.rst b/docs/source/CONTRIBUTING.rst new file mode 100644 index 0000000..081db43 --- /dev/null +++ b/docs/source/CONTRIBUTING.rst @@ -0,0 +1,8 @@ +Contributing +============ + +We welcome, and greatly appreciate, contributions to `CSDMS +Workbench `__ tools. For +recommendations on how you can contribute, please see the CSDMS project +`CONTRIBUTING `__ +document. diff --git a/docs/source/LICENSE.rst b/docs/source/LICENSE.rst new file mode 100644 index 0000000..2a95ee8 --- /dev/null +++ b/docs/source/LICENSE.rst @@ -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. diff --git a/docs/source/index.rst b/docs/source/index.rst index 443439f..3f022c8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -30,7 +30,9 @@ Project documents .. toctree:: :maxdepth: 2 - license + LICENSE + CODE-OF-CONDUCT + CONTRIBUTING Indices and tables .................. diff --git a/docs/source/license.rst b/docs/source/license.rst deleted file mode 100644 index 356aa9f..0000000 --- a/docs/source/license.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../LICENSE.md diff --git a/noxfile.py b/noxfile.py index ce48098..68f48c6 100644 --- a/noxfile.py +++ b/noxfile.py @@ -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" )