{"id":18948377,"url":"https://github.com/oxid-esales/developer_documentation","last_synced_at":"2026-03-27T12:30:17.241Z","repository":{"id":7073116,"uuid":"45610331","full_name":"OXID-eSales/developer_documentation","owner":"OXID-eSales","description":"OXID eShop Developer Documentation","archived":false,"fork":false,"pushed_at":"2025-02-14T10:35:34.000Z","size":7704,"stargazers_count":10,"open_issues_count":0,"forks_count":27,"subscribers_count":24,"default_branch":"b-7.3.x","last_synced_at":"2025-02-14T11:34:17.743Z","etag":null,"topics":["documentation","restructuredtext","shpinx"],"latest_commit_sha":null,"homepage":"https://docs.oxid-esales.com/developer/en/6.4/","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OXID-eSales.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2015-11-05T12:38:52.000Z","updated_at":"2025-01-31T13:59:42.000Z","dependencies_parsed_at":"2023-02-16T20:30:53.059Z","dependency_job_id":"8d8cceb5-da49-472d-8632-c89e171f1bd7","html_url":"https://github.com/OXID-eSales/developer_documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fdeveloper_documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fdeveloper_documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fdeveloper_documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OXID-eSales%2Fdeveloper_documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OXID-eSales","download_url":"https://codeload.github.com/OXID-eSales/developer_documentation/tar.gz/refs/heads/b-7.3.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239946902,"owners_count":19723017,"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","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","restructuredtext","shpinx"],"created_at":"2024-11-08T13:13:21.353Z","updated_at":"2026-03-27T12:30:17.181Z","avatar_url":"https://github.com/OXID-eSales.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"OXID eShop developer documentation\n==================================\n\nThis is the OXID eShop developer documentation.\n\nThe generated documentation can be found here: https://docs.oxid-esales.com/developer/en/7.0-rc.2/\n\nIf you want to contribute, please read https://docs.oxid-esales.com/developer/en/7.0-rc.2/index.html#help-improving-this-documentation.\nGenerate the documentation locally in order to test your changes as described in the following section.\n\nGenerating docs locally\n-----------------------\n\nTo generate documentation locally, our SDK with preconfigured Sphinx container can be used. Please refer to `SDK README file Sphinx usage section \u003chttps://github.com/OXID-eSales/docker-eshop-sdk#using-sphinx-container-for-documentation-generation\u003e`_.\n\nThe Old way:\n~~~~~~~~~~~~\n\n#. Install `sphinx \u003chttp://www.sphinx-doc.org/\u003e`__.\n#. Install the `sphinx_rtd_theme \u003chttps://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html\u003e`__ (if it is missing).\n#. Install the `PHP highlighting extensions \u003chttps://github.com/fabpot/sphinx-php\u003e`__.\n#. Install the `plantuml extension \u003chttps://pypi.python.org/pypi/sphinxcontrib-plantuml\u003e`__.\n\n   If you have a mac PC, install plantuml separately e.g. via `brew \u003chttps://formulae.brew.sh/formula/plantuml\u003e`__.\n\n   Either configure the path to the file `plantuml.jar` in the file `config.py` or put a wrapper script in your path as described in the link above.\n#. Clone thw documentation repository:\n    .. code:: bash\n\n        git clone https://github.com/OXID-eSales/developer_documentation.git\n\n#. To generate documentation, run:\n    .. code:: bash\n\n        cd developer_documentation\n        sphinx-build ./ ./build\n\n#. Open `build/index.html` file with your browser.\n\nGenerating diagrams\n-------------------\n\nTo generate diagrams using plantUml, use this command:\n\n.. code:: bash\n\n   java -jar /opt/plantuml.jar -svg -o ./ **.puml\n   \n*/opt/plantuml.jar - path to your plantUml file.*\n\nPlantUml will generate .svg files, which can be used in documentation.\n\nUsing OXID SDK for regenerating the documentation\n-------------------------------------------------\n\nBy being in the root of the project (where Makefile is), install the documentation and required containers by using\nfollowing commands:\n\n.. code:: bash\n\n    git clone https://github.com/OXID-eSales/developer_documentation docs\n    make addsphinxservice docpath='./docs'\n    docker-compose up --build -d sphinx\n\nTo run documentation regeneration, use:\n\n.. code:: bash\n\n    make generate-docs\n\nGenerated documentation will be available in `docs/build` folder","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Fdeveloper_documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxid-esales%2Fdeveloper_documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxid-esales%2Fdeveloper_documentation/lists"}