Update the docs with deprecation warning

berinhard · Oct 21, 2019 · ec66f2e · ec66f2e
1 parent b86068c
commit ec66f2e
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 65 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,75 +1,18 @@
 Model Mommy: Smart fixtures for better tests
 ============================================
 
-Model-mommy offers you a smart way to create fixtures for testing in Django.
-With a simple and powerful API you can create many objects with a single line of code.
+**IMPORTANT:** Model Mommy is no longer maintained and was replaced by `Model Bakery <https://pypi.org/project/model-bakery/>`_. Please, consider `migrating your project <https://model-bakery.readthedocs.io/en/latest/migrating_from_mommy.html>`_ to use the new lib.
 
+Model Mommy's creator and the maintainers decided to rename the project to not reinforce gender stereotypes for women in technology. You can read more about this subject `here <https://www.witi.com/articles/1017/How-Gender-Stereotypes-are-Still-Affecting-Women-in-Tech/>`_.
 
-Contributing to Model Mommy
-===========================
 
-As an open source project, Model Mommy welcomes contributions of many forms
-
-Examples of contributions include:
-
-* Code Patches
-* Documentation improvements
-* Bug reports
-
-
-Compatibility
-=============
-
-model_mommy supports Django >= 1.11 and Python 3
-
-Install
-=======
-
-Run the command above ::
-
-    pip install model_mommy
-
-Contributing
-============
-
-1. Prepare a virtual environment.
-
-.. code-block:: console
-
-    pip install virtualenvwrapper
-    mkvirtualenv model_mommy --no-site-packages --distribute
-
-2. Install the requirements.
-
-.. code-block:: console
-
-    pip install -r dev_requirements.txt
-
-3. Run the tests.
-
-.. code-block:: console
-
-    make test
-
-Inspiration
-===========
-
-*Model-mommy* was inspired by many great open source software like ruby's ObjectDaddy and FactoryGirl.
-
-
-Doubts? Loved it? Hated it? Suggestions?
-========================================
-
-Join our mailing list for support, development and ideas!
-
-*  https://groups.google.com/group/model-mommy
-
-
-Contents:
+Contents
+--------
 
 .. toctree::
    :maxdepth: 4
 
+   install
    basic_usage
    how_mommy_behaves
    recipes
@@ -78,9 +21,6 @@ Contents:
    extensions
 
 
-
-
-
 Indices and tables
 ==================
 

diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -0,0 +1,22 @@
+Install Instructions
+====================
+
+Model-mommy offers you a smart way to create fixtures for testing in Django.
+With a simple and powerful API you can create many objects with a single line of code.
+
+Compatibility
+=============
+
+model_mommy supports Django >= 1.11 and Python 3
+
+Install
+=======
+
+Run the command above ::
+
+    pip install model_mommy
+
+Inspiration
+===========
+
+*Model-mommy* was inspired by many great open source software like ruby's ObjectDaddy and FactoryGirl.