[Docs] Add monodocs build in flytesnacks CI

[cosmicBboy]

Description

This ticket is to add the monodocs build in the flyte repo as a github actions workflow step to make sure that flytesnacks changes don't break monodocs

Are you sure this issue hasn't been raised already?

• Yes

Have you read the Code of Conduct?

• Yes

[dosubot]

🤖

Hey @cosmicBboy! 🖖 I'm Dosu, your friendly neighborhood bot. I'm here to help you squash bugs, streamline your contributions, and answer any questions while you wait for a human maintainer. Let's make some code magic together! 🎩🐇💻

Sure, you can add the monodocs build in the flyte repository as a GitHub Actions workflow step. This can be done by adding a new job in the workflow file .github/workflows/tests.yml. Here is a sample job configuration:

  monodocs:
    runs-on: ubuntu-latest
    steps:
      - name: Fetch the code
        uses: actions/checkout@v2
      - name: Set up Python
        uses: actions/setup-python@v2
        with:
          python-version: 3.9
      - name: Install dependencies
        run: pip install -r requirements.txt
      - name: Build monodocs
        run: make monodocs

Please replace pip install -r requirements.txt and make monodocs with the actual commands to install dependencies and build monodocs. This job will run on every push and pull request, and it will fail if the monodocs build fails. You can find the workflow file here.

To build monodocs in the context of the flyte repository, you would use the make monodocs command. This command will invoke the sphinx-build tool with the -M option, passing monodocs as the target. The source directory is . (the current directory), and the build directory is _build. Any additional options can be passed through the SPHINXOPTS variable. You can find the Makefile here.

The dependencies required to build monodocs in the flyte repository are listed in the doc-requirements.in file in the flyteidl directory of the flyte repository. You can find the file here.

I hope this helps! If you have any other questions, feel free to ask.

Sources

• .github/workflows/tests.yml
• rsts/Makefile
• flyteidl/doc-requirements.in

---

This response is meant to be useful and save you time. It is not meant to be a precise solution, but rather a starting point for your own research.

Help me be more useful! Please leave a 👍 if this is helpful and 👎 if it is irrelevant.

If you want to continue the conversation, start your reply with @dosu-bot.