search

StatCan / aaw

Documentation for the Advanced Analytics Workspace Platform
https://statcan.github.io/aaw/
Other
68 stars 12 forks source link

pypi repo: please (consider) adding package: mdx-include #1723

Closed culkeri closed 1 year ago

culkeri commented 1 year ago

DAS-GAE (geo) leverages the AAWs antifactory.

As part of the dev work, I am writing our user-guide. I would like to add the include extension (mdx-include) to our mkdocs; but it does not appear to be part of the repo. If it passes the scans, please add it.

or suggest an alternative if you are aware of one.

Background: One of the tools we are documenting has its help content spread across multiple pages. I want to create a 'master' page, let's call it Page C, that combines the content from Page A and Page B without the need for manual copy-pasting. The goal is to ensure that any changes made to Page A or Page B are automatically reflected in Page C upon running the build process.

the include extension seems to meet this need (i think, I haven't tested it on my personal PC so I am guessing based off the include documentation).

The syntax for include extension would be:

#Page C

[!INCLUDE [File A](path/to/file-a.md)]
[!INCLUDE [File B](path/to/file-b.md)]
Souheil-Yazji commented 1 year ago

Hi @culkeri

Is this work being done on a jupyterlab notebook? If yes, you should be able to use pip install mdx-include

Image

culkeri commented 1 year ago

I am not using a notebook. This is on a GAE VM trying to install using miniforge. I do not have the environment configured so my attempt was: `pip install mdx-include -i https://jfrog.aaw.cloud.statcan.ca/artifactory/pypi-remote/.pypi/

Maybe the syntax is wrong? It installs on AVD, which also uses the AAW artifactory, so I can run the build command there.

Souheil-Yazji commented 1 year ago

@culkeri could you please provide the error you're getting, I'm not sure about the GAE VM. Also there's a typo in your url /pypi/

culkeri commented 1 year ago

sorry, I forgot to update this ticket.

I figured out the error, I was using the wrong URL. https://jfrog.aaw.cloud.statcan.ca/artifactory/api/pypi/pypi-remote/simple is the correct one to install packages.