-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- change default value for allowed flags to 10. - correct some grammatical errors in readme. - add badges for read the docs, python and django versions. .
- Loading branch information
1 parent
57868ea
commit 22d8670
Showing
17 changed files
with
531 additions
and
136 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Minimal makefile for Sphinx documentation | ||
# | ||
|
||
# You can set these variables from the command line, and also | ||
# from the environment for the first two. | ||
SPHINXOPTS ?= | ||
SPHINXBUILD ?= sphinx-build | ||
SOURCEDIR = . | ||
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) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
# Configuration file for the Sphinx documentation builder. | ||
# | ||
# This file only contains a selection of the most common options. For a full | ||
# list see the documentation: | ||
# https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
||
# -- Path setup -------------------------------------------------------------- | ||
|
||
# If extensions (or modules to document with autodoc) are in another directory, | ||
# add these directories to sys.path here. If the directory is relative to the | ||
# documentation root, use os.path.abspath to make it absolute, like shown here. | ||
# | ||
import os | ||
# import sys | ||
# sys.path.insert(0, os.path.abspath('.')) | ||
|
||
BASE_DIR = os.path.dirname((os.path.dirname(os.path.abspath(__file__)))) | ||
|
||
|
||
def get_version(): | ||
with open(os.path.join(BASE_DIR, 'VERSION')) as version_file: | ||
version = version_file.read().strip() | ||
return version | ||
|
||
|
||
# -- Project information ----------------------------------------------------- | ||
|
||
project = 'Django Flag App' | ||
copyright = '2020, Abhyudai' | ||
author = 'Abhyudai' | ||
|
||
# The short X.Y version | ||
version = get_version() | ||
# The full version, including alpha/beta/rc tags | ||
release = get_version() | ||
|
||
|
||
# -- 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 = [ | ||
'sphinx.ext.autosectionlabel', | ||
] | ||
|
||
# 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 = ['_build', 'Thumbs.db', '.DS_Store'] | ||
|
||
|
||
# -- 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'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
=============================== | ||
Contributing to Django Flag App | ||
=============================== | ||
|
||
There are many ways to contribute to the project. You may improve the documentation, address a bug, add some feature to the code or do something else. All sort of contributions are welcome. | ||
|
||
|
||
Development | ||
----------- | ||
|
||
To start development on this project, fork this repository and follow the following instructions. | ||
|
||
.. code:: sh | ||
# clone the forked repository | ||
$ git clone YOUR_FORKED_REPO_URL | ||
# create a virtual environment | ||
$ python3 -m venv venv | ||
# activate the virtual environment | ||
$ source venv/bin/activate | ||
# install dependencies | ||
(venv) $ pip install -e . -r testapp/requirements.txt | ||
# migrate the migrations to the database | ||
(venv) $ python manage.py migrate | ||
# create data | ||
(venv) $ python manage.py create_initial_data | ||
# start the development server | ||
(venv) $ python manage.py runserver | ||
Testing | ||
------- | ||
|
||
To run tests against a particular ``python`` and ``django`` version installed inside your virtual environment, you may use: | ||
|
||
.. code:: sh | ||
(venv) $ python manage.py test | ||
To run tests against all supported ``python`` and ``django`` versions, you may run: | ||
|
||
.. code:: sh | ||
# install dependency | ||
(venv) $ pip install tox | ||
# run tests | ||
(venv) $ tox |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
Welcome to Django Flag App's documentation! | ||
=========================================== | ||
|
||
.. toctree:: | ||
:maxdepth: 2 | ||
:caption: Contents: | ||
|
||
introduction | ||
webAPI | ||
settings | ||
style-customisation | ||
contributing | ||
|
||
|
||
|
||
Indices and tables | ||
================== | ||
|
||
* :ref:`genindex` | ||
* :ref:`modindex` | ||
* :ref:`search` |
Oops, something went wrong.