Welcome to the APEx documentation portal

This GitHub repository serves as the central hub for managing the APEx documentation portal. The content generation is facilitated by Quarto, an open-source scientific and technical publishing system.

Installing Python dependencies

Some documentation pages may include Python code to enable interactive visualizations or dynamic content generation. To support the creation of these pages, it's essential to install all the necessary dependencies. This can be done by executing the following command:

pip install -r requirements.txt

Previewing Documents

To preview the content and any changes you make, it's crucial to install the Quarto CLI beforehand. Once installed, you can preview the content by running the following command in your terminal:

quarto preview .

This command will initiate a local preview of the documentation portal, allowing you to review your changes before committing them.

Deliverables

Since the content of this repository is also included in a deliverable, we can use the Quarto framework to generate the deliverable content. To preview the deliverable, execute the following command:

quarto preview deliverable/<name>.md

To generate the corresponding Word document, use the following command:

quarto render deliverable/<name>.md --to docx