Create Documentation about django-bootstrap3 HOT 4 CLOSED

👍

from django-bootstrap3.

I'd love better documentation, but my time is pretty limited right now (I can use on the technical aspects of django-bootstrap3 because I'm using it in my current project).

I'd appreciate it if someone could suggest a proper setup for documentation, preferably integrated with readthedocs and/or github pages.

Thanks!

from django-bootstrap3.

Hi @dyve. You know the "cookiecutter-djangopackage"[1]? Using it is very simple to create a new pluggable app for django, with the basic skeleton of the Sphinx based documentation and the basic integration settings with Travis-CI, Coveralls and Tox.

To integrate with Read The Docs is relatively easy. You register the project [2], and then you activate the respective webhook Github as described here [3].

I'm also with little free time, but on Saturday, I will try to create the basic skeleton of the documentation.

ps. your setup.py file using some features (get_version, get_packages, get_package_data) to more than available from the setup.py "cookiecutter-djangopackage"[4].

These functions are really necessary?
Which case they would be useful?
Sorry for this question. It's what I always remember the Zen of Python, "Simple is better than complex." ;-)

[1] https://github.com/pydanny/cookiecutter-djangopackage
[2] https://readthedocs.org/dashboard/import/
[3] http://read-the-docs.readthedocs.org/en/latest/webhooks.html # github
[4] https://github.com/pydanny/cookiecutter-djangopackage/blob/master/%7B%7Bcookiecutter.repo_name%7D%7D/setup.py

from django-bootstrap3.

@dyve
http://django-bootstrap3.readthedocs.org/en/latest/templatetags.html
https://github.com/dyve/django-bootstrap3/blob/master/bootstrap3/templatetags/bootstrap3.py

I believe that the minimum documentation is not yet complete.
When did the first version of documentation, I marked with "FIX THIS" all templatetags that accept more parameters besides the common "form" instance.
It needed some examples showing how to use these other parameters and remove the text "FIX THIS" to not cause confusion

Live long and prosper 👍

from django-bootstrap3.