mirror of
https://github.com/NicolasBohn/NexQuant.git
synced 2026-07-29 08:27:43 +00:00
CI checks that can be automatically repaired (#119)
* fix isort & black & toml-sort & sphinx error * fix ci error * fix ci error * add comments * Update Makefile * change sphinx build command * add auto-lint * add black args * format with black * Auto Linting document * fix ci error --------- Co-authored-by: you-n-g <you-n-g@users.noreply.github.com> Co-authored-by: Young <afe.young@gmail.com>
This commit is contained in:
+1
-1
@@ -16,7 +16,7 @@ author = "Microsoft"
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
"sphinx.ext.autodoc",
|
||||
]
|
||||
|
||||
autodoc_member_order = "bysource"
|
||||
|
||||
@@ -11,12 +11,18 @@ For Development
|
||||
make dev
|
||||
```
|
||||
|
||||
- Run linting and formatting.
|
||||
- Run linting and checking.
|
||||
|
||||
```bash
|
||||
make lint
|
||||
```
|
||||
|
||||
- Some linting issues can be fixed automatically. We have added a command in the Makefile for easy use.
|
||||
|
||||
```bash
|
||||
make auto-lint
|
||||
```
|
||||
|
||||
|
||||
Code Structure
|
||||
=========================
|
||||
|
||||
@@ -17,6 +17,7 @@ Welcome to RDAgent's documentation!
|
||||
development
|
||||
api_reference
|
||||
policy
|
||||
test_dropdown/test1
|
||||
|
||||
.. test_dropdown/test1
|
||||
|
||||
|
||||
@@ -27,13 +27,16 @@ USE_AZURE_TOKEN_PROVIDER
|
||||
|
||||
### ☁️ Azure Configuration
|
||||
- Install Azure CLI:
|
||||
```sh
|
||||
curl -L https://aka.ms/InstallAzureCli | bash
|
||||
```
|
||||
|
||||
```sh
|
||||
curl -L https://aka.ms/InstallAzureCli | bash
|
||||
```
|
||||
|
||||
- Log in to Azure:
|
||||
```sh
|
||||
az login --use-device-code
|
||||
```
|
||||
|
||||
```sh
|
||||
az login --use-device-code
|
||||
```
|
||||
|
||||
- `exit` and re-login to your environment (this step may not be necessary).
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ Scenario lists
|
||||
-
|
||||
|
||||
Scnarios' demo & quick start
|
||||
=========================
|
||||
============================
|
||||
|
||||
Scen1
|
||||
-----
|
||||
@@ -69,7 +69,7 @@ TODO: Show some examples:
|
||||
|
||||
|
||||
Scen2:
|
||||
-----
|
||||
------
|
||||
📄 Research Report-Based Factor Extraction
|
||||
|
||||
Scen2 Intro
|
||||
|
||||
Reference in New Issue
Block a user