• Clone and Navigate the repo on your computer
• Build Locally the HTML documentation
• The Pipeline (optional)
• Style guide
• Prereq's to build a PDF version (optional)

If you make it here, it means you have access right to the How-To git repo. Thus you may "clone" it somewhere on your computer (like this. This will copy all files from the server onto your computer.

You may notice that the documentation in itself (the text) is located in the folders from cdm till webui. All the rest are actually configuration and support folders and files.

Requirements:

• Python 3.X
• Sphinx package (run python3 -m pip install sphinx)
• Sphinx Spelling package (run python3 -m pip install sphinxcontrib.spelling)
• Sphinx AIMMS theme (run python3 -m pip install sphinx-aimms-theme)
• AIMMS code blocks for PDF (run python3 -m pip install aimms-pygments-style)

Depending on previous installations of python, the above command may be py or python, instead of python3.

After installing all the above requirements, please go to the location of your previously cloned documentation folder:

• Open a console prompt from this location, using ATL+D and typing cmd in the URL of your file explorer (Windows)
• run make html (the first time, it may take some time, around 20 secs. progress is shown in your console)

💡 You may also run python3 -msphinx . _build/html (to be sure to use a specific python version). More docs

Alternative

As an alternative to setting things up on your local computer, use a docker container, see https://aimmsopt.sharepoint.com/sites/InternalSupportDocumentation/SitePages/Using-docker-to-build-the-documentation-locally.aspx

💡1: GitLab CI is following exactly the same process when building the documentation in the pipeline. This is defined in the .gitlab-ci.yml file. More details below

⚠️2: When pushing to the master branch only, the repo is built and pushed (merged) to documentation.aimms.com.

⚠️3: If any warning is raised on gitlab, the pipeline fails

After installing all the above requirements, please go to the location of your previously cloned documentation folder:

• Open a console prompt from this location, using ATL+D and typing cmd in the URL of your file explorer (Windows)
• run python3 -msphinx -b spelling . _build/spelling (depending on you python this could be just py or python instead of python3; the first time, it may take some time, around 20 secs. progress is shown in your console).

Every push to gitlab remote will run a pipeline. This pipeline first "Test" stage contains 3 different jobs as defined in .gitlab-ci.yml

``example.com`` 

.. spelling::

    word1
	word2

When pushing to the master branch

A push to master will run the pipeline and, if the Test stage is successful, it will copy the docs to documentation.aimms.com

If the pipeline fails, no copy will happen, thus website stays unchanged

Notes

1. If there is a link you want to ignore, put it

``example.com`` 

Guidelines

1. PUBLISHING PROCESS - Create a Create a new branch for editing, and merge to develop branch when ready. It will be reviewed and published weekly. Please don't work in the master branch except in urgent cases (use your judgment).

2. IMAGES - When using screenshots, leave plenty of space around the area you want to show so the image can be edited and edges can be beautified. Use markup sparingly.

3. IMAGE LOCATION - Keep icons in the icon folder (they can be reused for many docs). Specific images should be in their own images folder in the numbered folder for that article, eg Articles/233/images.

4. FILE NAME CONVENTIONS - Use the Gitlab ticket number for the "id number" of your article and give it a short but descriptive file name. (Occasionally there can be more than one article under the same ticket number, but generally try to make a new ticket for each article.)

5. RST CONVENTIONS - Always follow the same code conventions for headings, images, etc. The code is flexible, but we want docs to be consistent.

6. LINKING TO ARBITRARY ANCHORS - Titles may change, headings may change. Avoid link to headings by their title, instead create references (anchors) in the code using :ref: - if the title of a heading changes, links in other docs won't be broken.

7. LINKING TO OTHER FILES - Use :doc: to link to other files in the same repo. It will automatically pull the up-to-date title.

8. LINKING TO FUNCTION REFERENCE - Use :aimms:set:AllIdentifiers or `:any:`AllIdentifiers. This will create a link to the documentation for that function.

Quick reference

== Title (level 1) marker

-- Heading (level 2) marker

^^ Subheading (level 3) marker

.. Commented text

.. code-block:: aimms

*Italics*

**Bold**

``Monospace font``

#. Numbered list item

* Unordered list item

`External Link <www.url.com>`_

See also: http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html

Useful directives and roles in reST

Table of contents or index

.. toctree::

Use the sub-options :max-depth: or :titlesonly: appropriately, otherwise all sub-headings will show up in the table of contents leading to a long long list. Below two are equivalent.

.. toctree::
   :maxdepth: 1

.. toctree::
   :titlesonly:

Image

.. image:: /relativeFilePath/image.png

http://docutils.sourceforge.net/docs/ref/rst/directives.html#image

Code blocks, numbered

 .. code-block::
    :linenos:

Substitution

Can be useful for images, but any object or text string you may want to single-source for use in multiple docs.

Name the substitution in the header

.. |image-name| image:: /Images/image-name.png

Call the substitution in the document

|image-name|

http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#substitution-definitions

Download

Add a downloadable file to your page

:download:`this example script <downloads/example.py>`.

Relative file path

The given filename is usually relative to the current file. (../ represents go up a level, ../../ represents go up two levels, etc.)

http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#referencing-downloadable-files

Relative link

To link to another reST file in the same repo, you can use the :doc: role

:doc:`file-name`

or

:doc:`../file-name`

The link displays the title within the given document, or specify text to display explicitly

    :doc:`explicit title <filePath/file-name>`

http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-documents

Cross-reference

Like an anchor, but can be referenced by name from any other doc in the repo by name (no file path needed). Used above a section header.

Name the anchor

.. _my-reference-label:

Section to cross-reference
--------------------------

This is the text of the section.

Refer to the anchor

See :ref:`my-reference-label`.

http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref

Include

Use this to add contents of an entire file in the repo to your document as a snippet. (We use this in How-to for the feedback form at the bottom.)

.. include:: inclusion.txt

http://docutils.sourceforge.net/docs/ref/rst/directives.html#include

You can use the make latexpdf command to locally create a .pdf from the .rst source files.

First, make sure you installed Latex - https://miktex.org/howto/install-miktex

Then, to get the AIMMS code to look right, you need to run this:

python -m pip install aimms-pygments-style

This will install an extension enabling latex to find the AIMMS style sheet define in the following open source repo https://gitlab.com/ArthurdHerbemont/aimms-pygments-style. Please contribute if you think you can improve it ! :)