To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 81a92a5a authored by vermeul's avatar vermeul
Browse files

Update 17-Modules.md

parent 088c3fff
# Modules
## Include documentation
**include your README.md in your setup.py**
Every project should include a `README.md` file which describes how the module should be used. The Python Package Index (PyPi) will render the content on its website if you include it in the `long_description` parameter. Do not forget the encoding and set it to `utf-8`:
<strong>
```python
with open("README.md", "r", encoding="utf-8") as fh:
long_description = fh.read()
setup(
name='my_famous_first_module',
description='A module which makes everything easier.',
long_description=long_description,
)
```
</strong>
## Version requirements
**Enforce your version requirements programmatically**
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment