Skip to content

Commit f2f6b97

Browse files
MiltonLnMiltonLn
committed
Created base docs with sphinx, unfinished. README enhanced.
1 parent 412a657 commit f2f6b97

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+16702
-12
lines changed

‎README.rst

+20-12
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@ Features:
2222
- Conditional menu items display through validators (Permissions,
2323
Authentications or whatever you want)
2424

25+
Documentation:
26+
--------------
27+
The full documentation for Django Menu Generator is allowed here: ADD URL
28+
2529
Installation:
2630
-------------
2731

@@ -43,10 +47,10 @@ You can install it with one of these options:
4347
Usage:
4448
------
4549

46-
1. Install 'django-menu-generator' as per the above instructions.
47-
2. Add 'menu\_generator' to your INSTALLED\_APPS.
48-
3. Add {% load menu\_generator %} to templates that will handle the
50+
1. Once installed, add ``'menu_generator'`` to your INSTALLED\_APPS.
51+
2. Add ``{% load menu_generator %}`` to templates that will handle the
4952
menus.
53+
3. Add the list dictionaries containing the menu items to the settings
5054

5155
.. code:: python
5256
@@ -117,16 +121,14 @@ Usage:
117121
},
118122
]
119123
120-
You can build the menu dictionaries list inside the project apps with
121-
``menus.py`` files, see the docs for more.
122-
123-
Then in your template, load the template tag to generate your menu.
124-
124+
Or you can build the menu dictionaries list inside the project apps with
125+
``menus.py`` files, see docs for more.
125126

126-
{% load menu\_generator %}
127+
4. In your template, load the template tag to generate your menu.
127128

128129
::
129130

131+
{% load menu_generator %}
130132
<!DOCTYPE html>
131133
<html>
132134
<head><title>Django Menu Generator</title></head>
@@ -183,7 +185,7 @@ Then in your template, load the template tag to generate your menu.
183185
</body>
184186
</html>
185187

186-
188+
5. Now you must to see your menus generated when you run your project
187189

188190
Running the tests:
189191
------------------
@@ -206,10 +208,14 @@ Author and mantainers:
206208

207209
`Juan Diego García <https://github.com/yamijuan>`__ - [email protected]
208210

211+
Mantained by:
212+
213+
|rady-logo|
214+
209215
Credits:
210216
--------
211217

212-
I'd like to thank `Val Kneeman <https://github.com/un33k>`__, the
218+
We would like to thank `Val Kneeman <https://github.com/un33k>`__, the
213219
original author of this project under the name 'menuware'
214220
https://github.com/un33k/django-menuware
215221

@@ -218,4 +224,6 @@ https://github.com/un33k/django-menuware
218224
.. |version-image| image:: https://img.shields.io/pypi/v/django-menu-generator.svg
219225
:target: https://pypi.python.org/pypi/django-menu-generator
220226
.. |coverage-image| image:: https://coveralls.io/repos/github/RADYConsultores/django-menu-generator/badge.svg?branch=master
221-
:target: https://coveralls.io/github/RADYConsultores/django-menu-generator?branch=master
227+
:target: https://coveralls.io/github/RADYConsultores/django-menu-generator?branch=master
228+
.. |rady-logo| image:: http://rady.com.co/static/logo_rady.png
229+
:target: http://rady.com.co

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SPHINXPROJ = DjangoMenuGenerator
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/_build_html/.buildinfo

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 8a703d352d7027c1cda77a37a842ed65
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_build_html/.doctrees/changelog.doctree

2.17 KB
Binary file not shown.

‎docs/_build_html/.doctrees/contribute.doctree

3.71 KB
Binary file not shown.

‎docs/_build_html/.doctrees/credits.doctree

2.98 KB
Binary file not shown.

‎docs/_build_html/.doctrees/environment.pickle

10.6 KB
Binary file not shown.

‎docs/_build_html/.doctrees/index.doctree

6.28 KB
Binary file not shown.

‎docs/_build_html/.doctrees/install.doctree

5.3 KB
Binary file not shown.

‎docs/_build_html/.doctrees/license.doctree

2.72 KB
Binary file not shown.

‎docs/_build_html/.doctrees/menugeneration.doctree

2.2 KB
Binary file not shown.

‎docs/_build_html/.doctrees/support.doctree

3.55 KB
Binary file not shown.

‎docs/_build_html/.doctrees/tests.doctree

2.56 KB
Binary file not shown.

‎docs/_build_html/.doctrees/urls.doctree

2.14 KB
Binary file not shown.

‎docs/_build_html/.doctrees/usage.doctree

32.7 KB
Binary file not shown.

‎docs/_build_html/.doctrees/validators.doctree

2.17 KB
Binary file not shown.

‎docs/_build_html/_sources/changelog.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
CHANGELOG
2+
=========

‎docs/_build_html/_sources/contribute.rst.txt

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Contribute
2+
===========
3+
4+
- Issue tracker: `https://github.com/RADYConsultores/django-menu-generator/issues <https://github.com/RADYConsultores/django-menu-generator/issues>`__
5+
- Source code: `https://github.com/RADYConsultores/django-menu-generator <https://github.com/RADYConsultores/django-menu-generator>`__

‎docs/_build_html/_sources/credits.rst.txt

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Credits
2+
========
3+
4+
We would like to thank `Val Kneeman <https://github.com/un33k>`__, the
5+
original author of this project under the name 'menuware'
6+
https://github.com/un33k/django-menuware

‎docs/_build_html/_sources/index.rst.txt

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
.. Django Menu Generator documentation master file, created by
2+
sphinx-quickstart on Wed Apr 26 22:30:34 2017.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Welcome to Django Menu Generator's documentation!
7+
=================================================
8+
9+
Django Menu Generator is a productivity tool that enables the generation of full featured menus through python
10+
dictionaries list, you only need to setup the HTML structure once for each menu you like to build and then use the
11+
dictionaries to generate menu items
12+
13+
Features:
14+
---------
15+
16+
- Tested support to Python 2.7, 3.4, 3.5, 3.6
17+
- Tested support to Django 1.8.18, 1.9.13, 1.10.7, 1.11
18+
- No database
19+
- Support unlimited menus
20+
- Icons support
21+
- Semi-Automatically identifies the selected item and his breadcrums
22+
- Conditional menu items display through validators (Permissions,
23+
Authentications or whatever you want)
24+
25+
Contents:
26+
---------
27+
28+
.. toctree::
29+
:maxdepth: 2
30+
31+
install
32+
usage
33+
menugeneration
34+
urls
35+
validators
36+
changelog
37+
tests
38+
contribute
39+
support
40+
license
41+
credits

‎docs/_build_html/_sources/install.rst.txt

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Installation
2+
=============
3+
4+
You can install Django Menu Generator with one of these options:
5+
6+
- ``easy_install django-menu-generator``
7+
- ``pip install django-menu-generator``
8+
- ``git clone https://github.com/RADYConsultores/django-menu-generator``
9+
10+
1. ``cd django-menu-generator``
11+
2. run python setup.py
12+
13+
- ``wget https://github.com/RADYConsultores/django-menu-generator/zipball/master``
14+
15+
1. unzip the downloaded file
16+
2. cd into django-menu-generator-\* directory
17+
3. run python setup.py

‎docs/_build_html/_sources/license.rst.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
License
2+
========
3+
4+
Released under a (`MIT <https://github.com/RADYConsultores/django-menu-generator/blob/master/LICENSE>`__) license.

‎docs/_build_html/_sources/menugeneration.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Menu Generation
2+
===============

‎docs/_build_html/_sources/support.rst.txt

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Support
2+
=======
3+
4+
If you are having issues, please let us know.
5+
Contact us at: [email protected]
6+
7+
This project is mantained by:
8+
9+
|rady-logo|
10+
11+
.. |rady-logo| image:: http://rady.com.co/static/logo_rady.png
12+
:target: http://rady.com.co

‎docs/_build_html/_sources/tests.rst.txt

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Running the tests
2+
==================
3+
4+
To run the tests against the current environment:
5+
6+
::
7+
8+
python manage.py test

‎docs/_build_html/_sources/urls.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
URLs
2+
====

‎docs/_build_html/_sources/usage.rst.txt

+142
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
Usage
2+
=====
3+
4+
1. Once installed, add ``'menu_generator'`` to your INSTALLED\_APPS.
5+
2. Add ``{% load menu_generator %}`` to templates that will handle the
6+
menus.
7+
3. Add the list dictionaries containing the menu items to the settings
8+
9+
.. code:: python
10+
11+
####################################################################################
12+
Example: settings.py
13+
####################################################################################
14+
15+
NAV_MENU_LEFT = [
16+
{
17+
"name": "Home",
18+
"url": "/",
19+
},
20+
{
21+
"name": "About",
22+
"url": "/about",
23+
},
24+
]
25+
26+
NAV_MENU_RIGHT = [
27+
{
28+
"name": "Login",
29+
"url": "login_url_view", # reversible
30+
"validators": ["menu_generator.validators.is_anonymous"],
31+
},
32+
{
33+
"name": "Register",
34+
"url": "register_view_url", # reversible
35+
"validators": ["menu_generator.validators.is_anonymous"],
36+
},
37+
{
38+
"name": "Account",
39+
"url": "/acount",
40+
"validators": ["menu_generator.validators.is_authenticated"],
41+
"submenu": [
42+
{
43+
"name": "Profile",
44+
"url": "/account/profile",
45+
},
46+
{
47+
"name": "Account Balance",
48+
"url": "/account/balance",
49+
"validators": ["myapp.profiles.is_paid_user"],
50+
},
51+
{
52+
"name": "Account Secrets",
53+
"url": "/account/secrets",
54+
"validators": ["menu_generator.validators.is_superuser"],
55+
}
56+
],
57+
},
58+
]
59+
60+
FOOTER_MENU_LEFT = [
61+
{
62+
"name": "Facebook",
63+
"url": "facebook.com/foobar",
64+
},
65+
{
66+
"name": "Contact US",
67+
"url": "/contact",
68+
},
69+
]
70+
71+
FOOTER_MENU_RIGHT = [
72+
{
73+
"name": "Address",
74+
"url": "/address",
75+
},
76+
]
77+
78+
Or you can build the menu dictionaries list inside the project apps with
79+
``menus.py`` files, see :doc:`menugeneration` for more.
80+
81+
4. In your template, load the template tag to generate your menu.
82+
83+
::
84+
85+
{% load menu_generator %}
86+
<!DOCTYPE html>
87+
<html>
88+
<head><title>Django Menu Generator</title></head>
89+
<body>
90+
<!-- NAV BAR Start -->
91+
{% get_menu "NAV_MENU_LEFT" as left_menu %}
92+
<div style="float:left;">
93+
{% for item in left_menu %}
94+
<li class="{% if item.selected %} active {% endif %}">
95+
<a href="{{ item.url }}"> <i class="{{ item.icon_class }}"></i> {{ item.name }}</a>
96+
</li>
97+
{% if item.submenu %}
98+
<ul>
99+
{% for menu in item.submenu %}
100+
<li class="{% if menu.selected %} active {% endif %}">
101+
<a href="{{ menu.url }}">{{ menu.name }}</a>
102+
</li>
103+
{% endfor %}
104+
</ul>
105+
{% endif %}
106+
{% endfor %}
107+
</div>
108+
109+
{% get_menu "NAV_MENU_RIGHT" as right_menu %}
110+
<div style="float:right;">
111+
{% for item in right_menu %}
112+
<li class="{% if item.selected %} active {% endif %}">
113+
<a href="{{ item.url }}">{{ item.name }}</a>
114+
</li>
115+
{% if item.submenu %}
116+
<ul>
117+
{% for menu in item.submenu %}
118+
<li class="{% if menu.selected %} active {% endif %}">
119+
<a href="{{ menu.url }}">{{ menu.name }}</a>
120+
</li>
121+
{% endfor %}
122+
</ul>
123+
{% endif %}
124+
{% endfor %}
125+
</div>
126+
<!-- NAV BAR End -->
127+
128+
<!-- Footer Start -->
129+
{% get_menu "FOOTER_MENU_LEFT" as left_footer_menu %}
130+
<div style="float:left;">
131+
<!-- loop through your left footer menus -->
132+
</div>
133+
134+
{% get_menu "FOOTER_MENU_RIGHT" as right_footer_menu %}
135+
<div style="float:right;">
136+
<!-- loop through your right footer menus -->
137+
</div>
138+
<!-- Footer End -->
139+
</body>
140+
</html>
141+
142+
5. Now you must to see your menus generated when you run your project

‎docs/_build_html/_sources/validators.rst.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Validators
2+
==========

‎docs/_build_html/_static/ajax-loader.gif

673 Bytes
Loading

0 commit comments

Comments
 (0)