Exclude GitHub README.md from final package

digitalfabrik · Dec 8, 2021 · a67dcc3 · a67dcc3
1 parent c7d6073
commit a67dcc3
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -154,6 +154,9 @@ jobs:
       - run:
           name: Fix dependency versions
           command: ./dev-tools/fix_dependencies.sh
+      - run:
+          name: Use alternative README.md file
+          command: mv integreat_cms/README.md .
       - run:
           name: Build integreat-cms package
           command: python setup.py sdist bdist_wheel

diff --git a/setup.cfg b/setup.cfg
@@ -11,7 +11,7 @@ project_urls =
 	Issues=https://github.com/Integreat/integreat-cms/issues
 	Source Code=https://github.com/Integreat/integreat-cms
 	Release Notes=https://integreat.github.io/integreat-cms/changelog.html
-long_description = file: integreat_cms/README.md
+long_description = file: README.md
 long_description_content_type = text/markdown
 license = Apache License 2.0
 license_file = LICENSE.txt

diff --git a/sphinx/packaging.rst b/sphinx/packaging.rst
@@ -22,7 +22,11 @@ Packaging for a Python repository like e.g. `PyPI <https://pypi.org/>`__ is auto
 
     ./dev-tools/fix_dependencies.sh
 
-3. After that, you can build the python package with :doc:`setuptools:index`::
+3. Move the README to make sure to include the PyPI-README instead of the GitHub-README::
+
+    mv integreat_cms/README.md .
+
+4. After that, you can build the python package with :doc:`setuptools:index`::
 
     pip3 install --upgrade pip setuptools wheel
     python3 setup.py sdist bdist_wheel