[Community Documentation Repository] The open source Product Information Management (PIM)
Branch: 3.0
Clone or download
Latest commit 9edf786 Feb 7, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Fix 3.0 branch Feb 5, 2019
.platform Add Platform.sh conf Mar 21, 2017
_images WIP: new theme, new organization Feb 4, 2015
_themes/akeneo Merge branch '2.3' into '3.0' Feb 5, 2019
app Merge branch '1.7' into merge-17-20 Jan 17, 2018
cloud_edition Fix 3.0 branch Feb 5, 2019
contribute_to_pim Merge branch "2.3" into branch "3.0" Feb 6, 2019
design_pim Fix 3.0 branch Feb 5, 2019
developer_guide/installation Merge branch '1.7' into merge-17-20 Nov 21, 2018
import_and_export_data Merge branch "2.3" into branch "3.0" Feb 6, 2019
install_pim Fix 3.0 broken links Feb 6, 2019
maintain_pim TIP-892: Update path Nov 7, 2018
manipulate_pim_data Fix 3.0 branch Feb 5, 2019
migrate_pim Fix 3.0 broken links Feb 6, 2019
onboarder Fix link to supervisor documentation Feb 6, 2019
scripts Add REST API doc May 8, 2014
src/Acme/Bundle TIP-892: Update namespaces Nov 9, 2018
technical_architecture Remove bundles/components docs Feb 7, 2019
technical_overview Merge remote-tracking branch 'origin/2.3' into merge2_3-master Nov 28, 2018
use_sso_authentication Fix SSO private Github link Feb 7, 2019
web [PIM-6979] Add gitkeep Nov 7, 2017
.gitignore ignore vscode configuration foler Dec 12, 2018
.platform.app.yaml Fixed PLATFORM_BRANCH display Sep 27, 2017
.travis.yml Bring back the check of the hyperlinks by Travis Feb 6, 2019
Dockerfile Merge branch "2.3" into branch "3.0" Feb 6, 2019
README.md Fix 3.0 branch Feb 5, 2019
akeneo_overview.png Introduced new documentation architecture (#605) Jun 5, 2017
build.sh Merge branch '1.7' into merge-17-20 Feb 16, 2018
composer.json Merge branch '1.7' into merge-17-20 Jan 17, 2018
conf.py Ignore local addresses for lint Feb 7, 2019
docker-compose.override.yml.dist Merge branch '2.3' into branch 'master' Jan 14, 2019
docker-compose.yml Merge branch '2.3' into branch 'master' Jan 14, 2019
favicon.ico Fix warnings Mar 22, 2017
index.rst AOB-303 - add documentation about SSO Jan 18, 2019

README.md

Akeneo PIM Documentation

The Akeneo PIM documentation

Installation

Clone this repository.

Linux

Install Sphinx.

    $ sudo apt-get install python-pip
    $ sudo pip install --upgrade pip
    $ sudo pip install sphinx~=1.5.3
    $ sudo pip install git+https://github.com/fabpot/sphinx-php.git
    $ sudo pip install git+https://github.com/mickaelandrieu/sphinxcontrib.youtube.git

Mac OS

    $ brew install python
    $ pip install sphinx
    $ pip install git+https://github.com/fabpot/sphinx-php.git
    $ pip install git+https://github.com/mickaelandrieu/sphinxcontrib.youtube.git

If you encounter the following error ValueError: ('Expected version spec in', 'sphinx~=1.5.3', 'at', '~=1.5.3') Use pip install --upgrade pip before install sphinx

Download composer curl -s https://getcomposer.org/installer | php and run php composer.phar install.

Build the documentation

From the ./pim-docs directory, run:

    $ sphinx-build -b html . ../pim-docs-build

The documentation will be generated inside ../pim-docs-build.

Validate the documentation

From the ./pim-docs directory, run:

    $ sphinx-build -nWT -b linkcheck . _build/

Make documentation code work with pim-community-dev or standard

Install pim-community.

Then, go to Akeneo PIM src/ directory and create a symlink Acme pointing to pim-docs/src/Acme.

Add all Acme bundles in app/AppKernel.php file.

Install the Akeneo Styleguide page

The needed files for Akeneo Styleguide are installed with the composer install. When you build the documentation, you will have an empty page /styleguide/index.html. You have to add a RewriteRule on your Apache configuration to redirect to /styleguide/index.php:

    RedirectMatch 301 /styleguide/index.html /styleguide/index.php

Contribution

Don't hesitate to suggest cookbook ideas via https://github.com/akeneo/pim-docs/issues.

Developer's notes

  • The folder /_themes/sphinx_rtd_theme is a clone from https://github.com/snide/sphinx_rtd_theme, and was updated on 2016-07. If you want to customize the Akeneo theme, please only update /_theme/akeneo_rtd theme.

Build the documentation with Docker

Install Docker.

[optional] To update the branch list with the current pim-docs branches, use:

sed -i -e "s/^\(.*\)'versions': .*,\(.*\)$/\1'versions': ['$(git branch -l|grep -x "\(^[ *]\+[0-9]\+\.[0-9]\+.*\)\|\(^[ *]\+master\)" | cut -c 3- | sort -r | paste -sd " ")'],\2/" conf.py

From the ./pim-docs directory, run:

    $ docker build . --tag pim-docs:3.0
    $ rm -rf pim-docs-build && mkdir pim-docs-build
    $ docker run --rm \
        -v $(pwd):/home/akeneo/pim-docs/data \
        pim-docs:3.0 \
        ./build.sh 3.0 --uid $(id -u) --gid $(id -g) --no-asset-check

The docs will be built into ./pim-docs-build.