10 lines
436 B
Markdown
10 lines
436 B
Markdown
## FederatedScope Documentation
|
|
Please run the following commands from this directory to compile the documentation. Note that FederatedScope must be installed first.
|
|
* The `requirements.txt` is only for documentation of API by Sphinx, which can be automatically generated by Github actions `FederatedScope/.github/workflows/sphinx.yml`.
|
|
* Download via `Artifacts` in Github actions.
|
|
|
|
```
|
|
pip install -r requirements.txt
|
|
make html
|
|
```
|