| Name | dj-docs JSON |
| Version |
0.1
JSON |
| download |
| home_page | |
| Summary | django application for documentation |
| upload_time | 2023-04-12 12:49:55 |
| maintainer | Sreeshanth |
| docs_url | None |
| author | Sreeshanth |
| requires_python | |
| license | MIT |
| keywords |
django docs
docs
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Basic Configuration
===================
Add ``dj_docs`` to the ``INSTALLED_APPS``
-----------------------------------------
.. code:: python
INSTALLED_APPS = [
# ...
'dj_docs',
]
Your ``settings.py`` file should now include ``dj_docs`` in the
``INSTALLED_APPS`` list. This will enable the dj_docs app in your Django
project.
Configuration for ``DOC_STRING_MODULES``
----------------------------------------
The ``DOC_STRING_MODULES`` setting in Django’s ``settings.py`` file
allows you to define documentation strings for your project’s modules,
classes, and functions.
To configure ``DOC_STRING_MODULES``, add the following code to your
``settings.py`` file:
.. code:: python
DOC_STRING_MODULES = [
{
"section": "enter title",
"modules": [
{
"module_name": "module",
"class": "module.class",
"function": "module.function",
"synopsis": "Description"
},
]
},
]
Replace ``"enter title"`` with the title of the page you want to add,
``"module"`` with the name of the module you want to document,
``"module.class"`` with the name of the class you want to document,
``"module.function"`` with the name of the function you want to
document, and ``"Description"`` with the description of the module,
class, or function.
You can add as many sections and modules as you need to document your
project.
Adding the Documentation URL Path
---------------------------------
To access the documentation for this Django app, you’ll need to add a
URL path to your ``urls.py`` file that includes the ``dj_docs`` app’s
URLs. Follow these steps:
.. code:: python
from django.urls import include # Import the `include` function from Django's `urls` module
urlpatterns = [
# ...
path('docs/', include('dj_docs.urls')), # add url for documentation url to django application
]
Raw data
{
"_id": null,
"home_page": "",
"name": "dj-docs",
"maintainer": "Sreeshanth",
"docs_url": null,
"requires_python": "",
"maintainer_email": "sreeshanththekkedath8@gmail.com",
"keywords": "django docs,docs",
"author": "Sreeshanth",
"author_email": "sreeshanththekkedath8@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7f/72/28381eb47af10bcdebc55627a08b48dbee25e55ed97dd2e798119496f844/dj_docs-0.1.tar.gz",
"platform": null,
"description": "Basic Configuration\n===================\n\nAdd ``dj_docs`` to the ``INSTALLED_APPS``\n-----------------------------------------\n\n.. code:: python\n\n INSTALLED_APPS = [\n # ...\n 'dj_docs',\n ]\n\nYour ``settings.py`` file should now include ``dj_docs`` in the\n``INSTALLED_APPS`` list. This will enable the dj_docs app in your Django\nproject.\n\nConfiguration for ``DOC_STRING_MODULES``\n----------------------------------------\n\nThe ``DOC_STRING_MODULES`` setting in Django\u2019s ``settings.py`` file\nallows you to define documentation strings for your project\u2019s modules,\nclasses, and functions.\n\nTo configure ``DOC_STRING_MODULES``, add the following code to your\n``settings.py`` file:\n\n.. code:: python\n\n DOC_STRING_MODULES = [\n {\n \"section\": \"enter title\",\n \"modules\": [\n {\n \"module_name\": \"module\",\n \"class\": \"module.class\",\n \"function\": \"module.function\",\n \"synopsis\": \"Description\"\n },\n ]\n },\n ]\n\nReplace ``\"enter title\"`` with the title of the page you want to add,\n``\"module\"`` with the name of the module you want to document,\n``\"module.class\"`` with the name of the class you want to document,\n``\"module.function\"`` with the name of the function you want to\ndocument, and ``\"Description\"`` with the description of the module,\nclass, or function.\n\nYou can add as many sections and modules as you need to document your\nproject.\n\nAdding the Documentation URL Path\n---------------------------------\n\nTo access the documentation for this Django app, you\u2019ll need to add a\nURL path to your ``urls.py`` file that includes the ``dj_docs`` app\u2019s\nURLs. Follow these steps:\n\n.. code:: python\n\n from django.urls import include # Import the `include` function from Django's `urls` module\n\n urlpatterns = [\n # ...\n path('docs/', include('dj_docs.urls')), # add url for documentation url to django application\n ]\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "django application for documentation",
"version": "0.1",
"split_keywords": [
"django docs",
"docs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "744dd85eff10c8f8ea7206867f7d998e9ef89224252cb8d174797d4a6e5d0e1d",
"md5": "1350b13268a542d69247b44dfda52e08",
"sha256": "cec2770112cfb51ec2207a4cda705aaa8a76f2025afb20c7723a4e0f77e781bd"
},
"downloads": -1,
"filename": "dj_docs-0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1350b13268a542d69247b44dfda52e08",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 11398,
"upload_time": "2023-04-12T12:49:52",
"upload_time_iso_8601": "2023-04-12T12:49:52.548731Z",
"url": "https://files.pythonhosted.org/packages/74/4d/d85eff10c8f8ea7206867f7d998e9ef89224252cb8d174797d4a6e5d0e1d/dj_docs-0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f7228381eb47af10bcdebc55627a08b48dbee25e55ed97dd2e798119496f844",
"md5": "c68e41585ddfb3e7af7a3aad512ec2be",
"sha256": "191d368c2b2dc2599c6361783993641231362dbbf3861cdaddcaebc08b42ba89"
},
"downloads": -1,
"filename": "dj_docs-0.1.tar.gz",
"has_sig": false,
"md5_digest": "c68e41585ddfb3e7af7a3aad512ec2be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 9121,
"upload_time": "2023-04-12T12:49:55",
"upload_time_iso_8601": "2023-04-12T12:49:55.111540Z",
"url": "https://files.pythonhosted.org/packages/7f/72/28381eb47af10bcdebc55627a08b48dbee25e55ed97dd2e798119496f844/dj_docs-0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-12 12:49:55",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "dj-docs"
}
