-
Notifications
You must be signed in to change notification settings - Fork 159
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
This ensures that VS Code or GitHub Codespaces can automatically create an environment where `make` can build the rst files. It also enables the rst preview pane in VS Code or GitHub Codespaces.
- Loading branch information
Showing
4 changed files
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
FROM debian:latest | ||
|
||
RUN apt-get update \ | ||
&& apt-get install -y \ | ||
gawk \ | ||
perl \ | ||
sed \ | ||
git \ | ||
python3 \ | ||
python3-pip \ | ||
pandoc \ | ||
biber \ | ||
latexmk \ | ||
texlive \ | ||
texlive-science \ | ||
texlive-fonts-extra \ | ||
texlive-plain-generic \ | ||
texlive-bibtex-extra \ | ||
&& apt-get clean | ||
|
||
# Install Python packages, after removing a file that breaks pip. | ||
RUN rm /usr/lib/python3.11/EXTERNALLY-MANAGED | ||
RUN pip install rst2html5 \ | ||
&& pip install docutils==0.19 | ||
|
||
RUN apt-get install -y locales \ | ||
&& echo "LC_ALL=en_US.UTF-8" >> /etc/environment \ | ||
&& echo "en_US.UTF-8 UTF-8" >> /etc/locale.gen \ | ||
&& echo "LANG=en_US.UTF-8" > /etc/locale.conf \ | ||
&& locale-gen en_US.UTF-8 | ||
|
||
ENV PATH=${PATH}:/root/.local/bin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"name": "Dev space", | ||
"dockerFile": "Dockerfile" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Using dev containers for editing this repo | ||
|
||
This repo uses devcontainer.json to ease configuring the tools necessary to run ``make``. | ||
You can use [Codespaces](https://docs.github.com/en/codespaces/developing-in-codespaces/developing-in-a-codespace) | ||
to make your contributions and validate your work. | ||
Or when using VS Code, use the "Dev Containers: Reopen in Container" command to create | ||
the docker container with the tools. | ||
|
||
## VS Code experience | ||
|
||
When using VS Code to edit .rst files, the following extensions will add a preview pane, | ||
and otherwise add tooling for the files you may be editing: | ||
|
||
- [Makefile Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.makefile-tools) | ||
- [reStructuredText](https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext) | ||
- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) | ||
- [reStructuredText Syntax highlighting](https://marketplace.visualstudio.com/items?itemName=trond-snekvik.simple-rst) | ||
- [Docker](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-docker) | ||
|
||
Note that these extensions are not endorsed nor been vetted by the Zcash Foundation. |