Skip to content

Commit

Permalink
deploy: ada7bec
Browse files Browse the repository at this point in the history
  • Loading branch information
brentyi committed Jul 12, 2023
1 parent 7711903 commit 9c73212
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 37 deletions.
Binary file modified .doctrees/development.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
20 changes: 1 addition & 19 deletions _sources/development.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -19,36 +19,18 @@ pip install -e .
pip install -e .[examples]
```

_Alternatively_, `poetry` can also be used:

```Bash
# Install poetry.
curl -sSL https://install.python-poetry.org | python3 -

# Install package.
cd ~/viser
poetry install

# Install example dependencies.
poetry install -E examples
```

After installation, any of the example scripts (`~/viser/examples`) should be
runnable. A few of them require downloading assets, which can be done via the
scripts in `~/viser/examples/assets`.

**Linting, formatting, type-checking.**

First install developer tools:
First, install developer tools:

```bash
# Using pip.
pip install -e .[dev]
pre-commit install

# Using poetry. `--all-extras` is equivalent to `-E examples -E dev`.
poetry install --all-extras
pre-commit install
```

It would be hard to write unit tests for `viser`. We rely on static typing for
Expand Down
18 changes: 1 addition & 17 deletions development/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -246,30 +246,14 @@ <h2>Python install<a class="headerlink" href="#python-install" title="Permalink
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="o">[</span>examples<span class="o">]</span>
</pre></div>
</div>
<p><em>Alternatively</em>, <code class="docutils literal notranslate"><span class="pre">poetry</span></code> can also be used:</p>
<div class="highlight-Bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install poetry.</span>
curl<span class="w"> </span>-sSL<span class="w"> </span>https://install.python-poetry.org<span class="w"> </span><span class="p">|</span><span class="w"> </span>python3<span class="w"> </span>-

<span class="c1"># Install package.</span>
<span class="nb">cd</span><span class="w"> </span>~/viser
poetry<span class="w"> </span>install

<span class="c1"># Install example dependencies.</span>
poetry<span class="w"> </span>install<span class="w"> </span>-E<span class="w"> </span>examples
</pre></div>
</div>
<p>After installation, any of the example scripts (<code class="docutils literal notranslate"><span class="pre">~/viser/examples</span></code>) should be
runnable. A few of them require downloading assets, which can be done via the
scripts in <code class="docutils literal notranslate"><span class="pre">~/viser/examples/assets</span></code>.</p>
<p><strong>Linting, formatting, type-checking.</strong></p>
<p>First install developer tools:</p>
<p>First, install developer tools:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># Using pip.</span>
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.<span class="o">[</span>dev<span class="o">]</span>
pre-commit<span class="w"> </span>install

<span class="c1"># Using poetry. `--all-extras` is equivalent to `-E examples -E dev`.</span>
poetry<span class="w"> </span>install<span class="w"> </span>--all-extras
pre-commit<span class="w"> </span>install
</pre></div>
</div>
<p>It would be hard to write unit tests for <code class="docutils literal notranslate"><span class="pre">viser</span></code>. We rely on static typing for
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit 9c73212

Please sign in to comment.