mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-22 23:55:36 +08:00
1 parent
46ac2fcf46
commit
046b5c216b
11 files changed
+59
-57
No files matched your search
@@ -11,6 +11,21 @@ The project is set up for development in VSCode, we recommend using it if you pl
|
||||
| Docs | Sphinx |
|
||||
| Docstring style | Google |
|
||||
|
||||
## Requirements
|
||||
|
||||
To install the required packages:
|
||||
|
||||
```bash
|
||||
pip install -e .[dev]
|
||||
pip install -e .[docs]
|
||||
```
|
||||
|
||||
You may also need to install [pandoc](https://pandoc.org/). If you are using `conda` you can run the following:
|
||||
|
||||
```bash
|
||||
conda install -c conda-forge pandoc
|
||||
```
|
||||
|
||||
## Committing
|
||||
|
||||
1. Make your modifications
|
||||
@@ -22,12 +37,12 @@ The project is set up for development in VSCode, we recommend using it if you pl
|
||||
python scripts/debugging/run_actions.py
|
||||
```
|
||||
|
||||
This will perform the following checks and actions:
|
||||
This will perform the following checks and actions:
|
||||
|
||||
- Black/ Linting style check: Ensure that the code is consistently and properly formatted.
|
||||
- Pytests: Runs pytests locally to make sure the logic of any added code does not break existing logic.
|
||||
- Documentation build: Builds the documentation locally to make sure none of the changes result in any warnings or errors in the docs.
|
||||
- Licensing: automatically adds licensing headers to the correct files.
|
||||
- Black/ Linting style check: Ensure that the code is consistently and properly formatted.
|
||||
- Pytests: Runs pytests locally to make sure the logic of any added code does not break existing logic.
|
||||
- Documentation build: Builds the documentation locally to make sure none of the changes result in any warnings or errors in the docs.
|
||||
- Licensing: automatically adds licensing headers to the correct files.
|
||||
|
||||
In order to merge changes to the code base, all of these checks must be passing. If you pass these tests locally, you will likely pass on github servers as well (results in a green checkmark next to your commit).
|
||||
|
||||
@@ -35,20 +50,6 @@ In order to merge changes to the code base, all of these checks must be passing.
|
||||
|
||||
## Documentation
|
||||
|
||||
### Requirements
|
||||
|
||||
To install the required packages:
|
||||
|
||||
```bash
|
||||
pip install -e .[docs]
|
||||
```
|
||||
|
||||
You may also need to install [pandoc](https://pandoc.org/). If you are using `conda` you can run the following:
|
||||
|
||||
```bash
|
||||
conda install -c conda-forge pandoc
|
||||
```
|
||||
|
||||
### Building
|
||||
|
||||
Run the following to build the documentation:
|
||||
|
||||
Reference in new issue
Block a user