{"id":20374860,"url":"https://github.com/gisce/powerp-docs","last_synced_at":"2025-10-10T15:08:18.749Z","repository":{"id":48680738,"uuid":"45821228","full_name":"gisce/powerp-docs","owner":"gisce","description":"GISCE PowERP Documentation","archived":false,"fork":false,"pushed_at":"2025-02-26T17:33:37.000Z","size":119531,"stargazers_count":7,"open_issues_count":32,"forks_count":4,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-04-12T07:17:05.311Z","etag":null,"topics":["documentation","erp","gisce","hacktoberfest","mkdocs"],"latest_commit_sha":null,"homepage":"http://manuales.gisce.net","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gisce.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-11-09T07:07:30.000Z","updated_at":"2025-02-26T17:33:40.000Z","dependencies_parsed_at":"2025-04-12T07:27:15.833Z","dependency_job_id":null,"html_url":"https://github.com/gisce/powerp-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gisce/powerp-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gisce%2Fpowerp-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gisce%2Fpowerp-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gisce%2Fpowerp-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gisce%2Fpowerp-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gisce","download_url":"https://codeload.github.com/gisce/powerp-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gisce%2Fpowerp-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004564,"owners_count":26083734,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","erp","gisce","hacktoberfest","mkdocs"],"created_at":"2024-11-15T01:27:23.074Z","updated_at":"2025-10-10T15:08:18.679Z","avatar_url":"https://github.com/gisce.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PowERP documentation\n\nOur docs are available in: [manuals.gisce.net](http://manuals.gisce.net/)\n\n**Table Of Contents**\n\n- [Environment](#setting-up-your-environment)\n    - [Recommended editors](#recommended-editors)\n- [Translations](#translate-docs)\n- [Display Documentation](#display-documentation)\n- [Project Structure](#project-structure)\n- [Coding references](#coding-references)\n- [Testing](#testing)\n\n## Setting up your environment\n\n```shell\n$ mkvirtualenv powerp-docs\n$ git clone git@github.com:gisce/powerp-docs.git\n$ cd powerp-docs\n$ pip install -r requirements.txt\n$ apt-get install gettext\n$ apt-get install poedit\n```\n\n### Recommended Editors\n\n#### Edit documentation files:\n\n**Atom**    \n_With the extensions:_\n\n- [markdown-toc](https://atom.io/packages/markdown-toc)\n    - Automatically creates TableOfContents.\n    - Can be easily configured.\n    - Can't parse special characters.\n    - Use only if ToC is needed in the docs you are writing.\n- [markdown-writer](https://atom.io/packages/markdown-writer)\n    - Hotkeys to markdown formats\n    - Can be extended\n    - Does not have config set, but you can set the default config...\n- [markdown-preview](https://atom.io/packages/markdown-preview)\n    - Prints the file built to html on a paralel workspace\n\n#### Translate docs:\n\nFor more detailed info, [check the wiki](https://github.com/gisce/powerp-docs/wiki/Translate!----build-your-docs-on-any-language).\n\nSet all file titles in the mkdocs.yml files.\nFor each language, there should be a translation.\n\nTo translate the text use:\n\n```shell\n./translate.sh\n```\n\nTo merge with master, you'll probably have conflicts with the pofile. There's\nquite a story behind, [you can learn more on the wiki].\n\nJust use the following:\n\n```shell\n./merge.sh\n```\n\n**Remember to commit after changes are applied**\n\n## Display documentation\n\nYou should [check the wiki](https://github.com/gisce/powerp-docs/wiki/Build!---Displaying-the-Docs) to learn more about this.\n\nThe essential commands are:\n\n* Serve - to build a webserver that auto-updates with changes in the docs.\n    - Does not update with the translations files\n    - **RECOMMENDED** While writting the docs\n* Build - to build the html from the docs into a folder.\n\nWith the \"-f\" argument, we specify the config file to be used.\n\ni.e.:\n\n```shell\n$ mkdocs serve  \n$ mkdocs serve -f mkdocs_es.yml\n$ mkdocs build\n$ mkdocs build -f mkdocs_es.yml\n```\n\n# Coding references\n\n- [Markdown Reference](https://pythonhosted.org/Markdown/index.html)\n- [MKDocs Reference](http://www.mkdocs.org/)\n\nMarkdown extensions:\n\n* [Tables](https://pythonhosted.org/Markdown/extensions/tables.html) (and [grid_tables](https://github.com/smartboyathome/Markdown-GridTables))\n* [Admonition](https://pythonhosted.org/Markdown/extensions/admonition.html)\n* [markdown_i18n](https://github.com/gisce/markdown-i18n)\n\n## Project structure\n\n_**NOTE**_: All filenames and directories should be in Spanish\n\nWe have 5 categories:\n\n- **base**: Base components: used in distri \u0026 comer\n- **distri**: Distri components\n- **comer**: Comer components\n- **facturacion**: Base invoicing components used in distri \u0026 comer\n- **gis**: GIS components\n\nFor images we use `_static` folder inside the category with a subfolder for the\nsame name as Markdown file of the Section.\n\ni.e.:\n\nFor `distri/atr.md` we have `distri/_static/atr/image1.png`\n\n# Testing\n\nOur travis testing includes:\n\n- mkdocs build -f mkdocs.yml\n- mkdocs build -f mkdocs_es.yml\n- Check for all strings translated in the .po\n- Check for all the strings in the .pot (after build) to be in the .po\n\n# Possible Upgrades\n\n## Images with CSS\n\nUsing alt text (or the source) to find the images.\n\nAdd your own css in the `docs/extra/css/images.css` directory.\n\nThe _css_ may have the format:\n\n```\nimg[alt=\"TextFromAlt\"]{}\nimg[src=\"TextFromSrc\"]{}\n```\n\nAnd the _markdown_ image should be like:\n\n```\n![TextFromAlt](TextFromSrc)\n```\n\nIf using alt as a _CSS class_, remember to use an image-defining name and also\ntranslate it. (i.e. alt=\"icon\" [icon-\u003eicona / icon-\u003eicono])\n\n## Footnotes\n\nWe are not using them, but we can add footnotes.\n\nTo add footnotes, first it's needed to add footnotes extension to config.yml:\n```\nvim mkdocs.yml\n```\nThen append the extension:\n```\nmarkdown_extensions:\n  - footnotes\n```\n\nUse it in any _.md_ document as in [footnotes docs](https://pythonhosted.org/Markdown/extensions/footnotes.html):\n```\nFootnotes[^1] have a label[^@#$%] and the footnote's content.\n\n[^1]: This is a footnote content.\n[^@#$%]: A footnote on the label: \"@#$%\".\n\n[^1]:\n    The first paragraph of the definition.\n\n    Paragraph two of the definition.\n\n    \u003e A blockquote with\n    \u003e multiple lines.\n\n        a code block\n\n    A final paragraph.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgisce%2Fpowerp-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgisce%2Fpowerp-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgisce%2Fpowerp-docs/lists"}