README GENERATOR
================
This package is based on the oca-gen-addon-readme from the OCA/maintainer-tools.git repo
wich is licensed AGPL-3
This is a small utility that generates high quality README for our odoo modules
in an automated way.
The sections of the final README are organized in fragments. They must be put inside a
readme folder respecting this structure.
tony_stark_module
├── views
├── readme
| ├── CONFIGURE.rst
| ├── CONTRIBUTORS.rst
| ├── CREDITS.rst
| ├── DESCRIPTION.rst
| ├── HISTORY.rst
| ├── INSTALL.rst
| ├── READMAP.rst
| └── USAGE.rst
├── reports
├── static
└── views
eg. To generate the final README for each module of the repository we can say (if we
are stand in the repository root)
gen-readme --repo-name=stark-enterprises --branch=16.0 --addon-dir="$PWD"
The result is a fully pypi compilant README.rst in the root of each module of the repo
Installation
------------
sudo pip install gen-odoo-readme
see proyect in https://pypi.org/project/gen-odoo-readme/
Use el comando gen-readme --help para obtener esta ayuda
Usage: gen-readme [OPTIONS]
Options:
--org-name TEXT Organization name [required]
--repo-name TEXT Repository name, eg. server-tools. [required]
--branch TEXT Odoo series. eg 11.0. [required]
--addons-dir DIRECTORY Directory containing several addons, the README
will be generated for all installable addons
found there. [required]
--gen-html / --no-gen-html Generate index html file.
--help Show this message and exit.
Recomendation
-------------
We recommend to set a small make_readme.sh file in each repo as this
#!/usr/bin/env bash
#################################
# Generate the odoo README.rst documentacion for each module in
# the current repository.
# you must install this: pip install gen-odoo-readme
gen-readme \
--web https://quilsoft.com \
--org-name quilsoft-org \
--repo-name star_enterprises \
--branch 16.0 \
--addons-dir "$PWD"
pre-commit hook
---------------
You can use this module as a pre-commit plugin this way
- repo: https://github.com/jobiols/gen-readme.git
rev: 1.2.2
hooks:
- id: gen-readme
Raw data
{
"_id": null,
"home_page": "https://github.com/jobiols/gen-readme",
"name": "gen-odoo-readme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "odoo documentation readme rst",
"author": "Jorge E. Obiols",
"author_email": "jorge.obiols@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7f/65/8b2b866f68d1dda6a7988d2f8ab856aa34fc965d162b66478e604df50059/gen-odoo-readme-1.2.9.tar.gz",
"platform": null,
"description": "\nREADME GENERATOR\n================\nThis package is based on the oca-gen-addon-readme from the OCA/maintainer-tools.git repo\nwich is licensed AGPL-3\n\nThis is a small utility that generates high quality README for our odoo modules\nin an automated way.\n\nThe sections of the final README are organized in fragments. They must be put inside a\nreadme folder respecting this structure.\n\n tony_stark_module\n \u251c\u2500\u2500 views\n \u251c\u2500\u2500 readme\n | \u251c\u2500\u2500 CONFIGURE.rst\n | \u251c\u2500\u2500 CONTRIBUTORS.rst\n | \u251c\u2500\u2500 CREDITS.rst\n | \u251c\u2500\u2500 DESCRIPTION.rst\n | \u251c\u2500\u2500 HISTORY.rst\n | \u251c\u2500\u2500 INSTALL.rst\n | \u251c\u2500\u2500 READMAP.rst\n | \u2514\u2500\u2500 USAGE.rst\n \u251c\u2500\u2500 reports\n \u251c\u2500\u2500 static\n \u2514\u2500\u2500 views\n\neg. To generate the final README for each module of the repository we can say (if we\n are stand in the repository root)\n\n gen-readme --repo-name=stark-enterprises --branch=16.0 --addon-dir=\"$PWD\"\n\nThe result is a fully pypi compilant README.rst in the root of each module of the repo\n\n\nInstallation\n------------\n\n sudo pip install gen-odoo-readme\n\nsee proyect in https://pypi.org/project/gen-odoo-readme/\n\nUse el comando gen-readme --help para obtener esta ayuda\n\n Usage: gen-readme [OPTIONS]\n\n Options:\n --org-name TEXT Organization name [required]\n --repo-name TEXT Repository name, eg. server-tools. [required]\n --branch TEXT Odoo series. eg 11.0. [required]\n --addons-dir DIRECTORY Directory containing several addons, the README\n will be generated for all installable addons\n found there. [required]\n --gen-html / --no-gen-html Generate index html file.\n --help Show this message and exit.\n\nRecomendation\n-------------\n\nWe recommend to set a small make_readme.sh file in each repo as this\n\n #!/usr/bin/env bash\n #################################\n # Generate the odoo README.rst documentacion for each module in\n # the current repository.\n # you must install this: pip install gen-odoo-readme\n\n gen-readme \\\n --web https://quilsoft.com \\\n --org-name quilsoft-org \\\n --repo-name star_enterprises \\\n --branch 16.0 \\\n --addons-dir \"$PWD\"\n\npre-commit hook\n---------------\n\nYou can use this module as a pre-commit plugin this way\n\n\n - repo: https://github.com/jobiols/gen-readme.git\n rev: 1.2.2\n hooks:\n - id: gen-readme\n",
"bugtrack_url": null,
"license": "",
"summary": "Tool to create README.rst files for Odoo",
"version": "1.2.9",
"project_urls": {
"Homepage": "https://github.com/jobiols/gen-readme"
},
"split_keywords": [
"odoo",
"documentation",
"readme",
"rst"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6114fd1decf17a006a16a553640c309dd6072ca3bb961d8ce3ea2649aa6087c9",
"md5": "4f06e13a3a16dc747b1cbc7bd7f1d14d",
"sha256": "41e262713dcb94b3452cf06cc4d0661019ca3bbc818fdaeddacf9dd22c3acc53"
},
"downloads": -1,
"filename": "gen_odoo_readme-1.2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f06e13a3a16dc747b1cbc7bd7f1d14d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 21666,
"upload_time": "2024-02-11T20:36:24",
"upload_time_iso_8601": "2024-02-11T20:36:24.185033Z",
"url": "https://files.pythonhosted.org/packages/61/14/fd1decf17a006a16a553640c309dd6072ca3bb961d8ce3ea2649aa6087c9/gen_odoo_readme-1.2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f658b2b866f68d1dda6a7988d2f8ab856aa34fc965d162b66478e604df50059",
"md5": "a45fcc9ecea1f0c7719428d1c260281c",
"sha256": "e6edadeff3506e1a99914edcff418a9847f5a15bc4329e51794c780e59f49985"
},
"downloads": -1,
"filename": "gen-odoo-readme-1.2.9.tar.gz",
"has_sig": false,
"md5_digest": "a45fcc9ecea1f0c7719428d1c260281c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19363,
"upload_time": "2024-02-11T20:36:25",
"upload_time_iso_8601": "2024-02-11T20:36:25.956637Z",
"url": "https://files.pythonhosted.org/packages/7f/65/8b2b866f68d1dda6a7988d2f8ab856aa34fc965d162b66478e604df50059/gen-odoo-readme-1.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-11 20:36:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jobiols",
"github_project": "gen-readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gen-odoo-readme"
}
JSON
