This document is intended to help you build the documentation that will eventually make its way into the live site: https://zowe-client-python-sdk.readthedocs.io/en/latest/index.html
- Python 3.13 or above: https://www.python.org/downloads/
- Sphinx: https://www.sphinx-doc.org/en/master/usage/installation.html#os-specific-package-manager
- Windows users may need to install Chocolatey: https://chocolatey.org/install
- I suggest going through the NodeJS installer and opt-in to instal Chocolatey in the final step
- I suggest going through the NodeJS installer and opt-in to instal Chocolatey in the final step
- Windows users may need to install Chocolatey: https://chocolatey.org/install
- Enchant: (Optional) https://pyenchant.github.io/pyenchant/install.html
These steps should help you to build the documentation
- Clone the repository, open a terminal, and
cdinto the repository directory - Create a virtual environment:
npm run env:create
- Activate the virtual environment:
npm run env:activate
- Install the doc dependencies
npm run doc:install
- Build and open the documentation:
npm run doc:dev