clean up project docs

2024-11-28 04:24:02 +03:00 · 2017-02-25 13:12:54 +01:00 · 2017-02-25 13:12:54 +01:00 · ca51219524
commit ca51219524
parent e079dfe17d
19 changed files with 17 additions and 7 deletions
--- a/{{cookiecutter.project_slug}}/docs/docker_ec2.rst
+++ b/{{cookiecutter.project_slug}}/docs/docker_ec2.rst
--- a/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/1.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/1.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/2.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/2.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/3.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/3.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/4.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/4.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/5.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/5.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/6.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/6.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/7.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/7.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/8.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/8.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/f1.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/f1.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/f2.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/f2.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/f3.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/f3.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/f4.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/f4.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/issue1.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/issue1.png
--- a/{{cookiecutter.project_slug}}/docs/pycharm/images/issue2.png
+++ b/{{cookiecutter.project_slug}}/docs/pycharm/images/issue2.png
--- a/{{cookiecutter.project_slug}}/docs/deploy.rst
+++ b/{{cookiecutter.project_slug}}/docs/deploy.rst
@ -1,4 +1,10 @@
 Deploy
-========
+======

-This is where you describe how the project is deployed in production.
+*describe how to deploy this project*
+
+This project was generated with Cookiecutter Django, take a look at the `official docs`_ for more
+info.
+
+
+.. _official docs: http://aws.amazon.com/
--- a/{{cookiecutter.project_slug}}/docs/index.rst
+++ b/{{cookiecutter.project_slug}}/docs/index.rst
@ -4,7 +4,7 @@
   contain the root `toctree` directive.

 Welcome to {{ cookiecutter.project_name }}'s documentation!
-====================================================================
+===========================================================

 Contents:

@ -13,8 +13,6 @@ Contents:

   install
   deploy
-   docker_ec2
-   tests



--- a/{{cookiecutter.project_slug}}/docs/install.rst
+++ b/{{cookiecutter.project_slug}}/docs/install.rst
@ -1,4 +1,10 @@
 Install
-=========
+=======

-This is where you write how to get a new laptop to run this project.
+*describe how to install this project*
+
+This project was generated with Cookiecutter Django, take a look at the `official docs`_ for more
+info.
+
+
+.. _official docs: http://aws.amazon.com/