Contribute

Everybody is welcome to discuss the content with us or even sends us Pull Requests, containing changes or additional information.

To do this, please create a PR on https://github.com/open-needs/open-needs.github.io.

It is also possible to talk directly to us, for this please write an e-mail to Daniel

Model definition

To describe / update a model for Open-Needs Models, please take a look into the folder /models.

Each schema has its own model and it gets imported to the documentation automatically by using .. jsonschema:: directive. See sphinx-jsonschema extension for details.

Sphinx setup

For everybody who wants to know which Sphinx extensions this side is using, here is the used doc-requirements.txt file:

sphinx
furo                        # The used theme
sphinxcontrib-plantuml      # Used for all architecture and mockup images
sphinxcontrib-httpdomain    # Used REST-API documentation
sphinxcontrib-needs         # need objects and filtering
sphinx-panels               # tabs, dropdonws, cards and more
sphinx-disqus               # comment field integration
sphinx-preview              # iframe-preview for links
sphinx-jsonschema           # nice schema representation as table
sphinx-data-viewer          # list view of schemas

Contributors

Maintainers
-----------

Daniel Woste <daniel@useblocks.com>

Contributors
------------

License

MIT License

Copyright (c) 2022 Open-Needs community

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.