diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 74facc0..5f3602a 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -29,9 +29,7 @@ jobs: - name: Setup dependencies run: | - pip install sphinx - pip install sphinx-rtd-theme - pip install --upgrade recommonmark + pip install -r requirements.txt - name: Build run: | diff --git a/README.md b/README.md index 26a6d95..207ca3e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ -# The Documentory of Torch_NPU +# The documentation of Ascend NPU for PyTorch(torch_npu) -This repository is a collection of documentation for torch_npu (Ascend NPU for PyTorch). +This repository is a collection of documentation, api and stuff like that for torch_npu (Ascend NPU for PyTorch). + +# Contributing If you are interested in the project, please feel free to contribute it. + +We use sphinx and rst file to create docs and you need to refer to rst syntax for help. +Here is how you can create a new docs: + +1. Create a rst file. You can put it anywhere, but it must be better to classify it. +2. Add the rst into the index.rst + +# Building locally + +When the development is ready, you can check and test it locally by following the directives below: + +1. Install the required dependencies: + `pip install -r requirements.txt` + +2. Building: + `make html` + +3. Server on localhost: + `python -m http.server -d build/html 4000` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..5d26a88 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +Sphinx +sphinx-autobuild +sphinx-rtd-theme +recommonmark