You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -22,7 +22,7 @@ The post will automatically be recognized and displayed when you build the porta
22
22
23
23
## Instructions for building the portal site
24
24
25
-
The portal site is built with [Sphinx](https://www.sphinx-doc.org/).
25
+
The portal site is built with [MyST-MD](https://mystmd.org/).
26
26
27
27
When testing new content it is important to build and view the site. Read the Docs automatically builds the site for you when each Pull Request is checked. However, you can also build it locally on your machine following the instructions
28
28
below.
@@ -70,28 +70,12 @@ _NOTE_: The `pre-commit` package is already installed via the `pythia` conda env
70
70
Build the site locally using Sphinx (which you just installed in the `pythia` environment, along with all necessary dependencies):
71
71
72
72
```bash
73
-
make html
73
+
myst start --execute
74
74
```
75
75
76
-
If this step fails and you have not updated your conda environment recently, try updating with `conda env update -f ../environment.yml` and `conda update --all` as described above.
76
+
If this step fails and you may not have updated your conda environment recently, try updating with `conda env update -f ../environment.yml` and `conda update --all` as described above.
77
77
78
-
The newly rendered site is now available in `portal/_build/html/index.html`.
79
-
Open with your web browser, or from the terminal:
80
-
81
-
```bash
82
-
open _build/html/index.html
83
-
`````
84
-
85
-
However, many of the links will not work. For all of the links
86
-
found in the portal to work properly, you'll need to set up a local
87
-
testing server. This can be done with Python's http.server by running
88
-
the following command from within the `portal` directory:
89
-
90
-
```bash
91
-
python -m http.server --directory _build/html/
92
-
```
93
-
94
-
and then pointing your browser at the URL: localhost:8000.
78
+
The newly rendered site is now available at [localhost:3000](http://localhost:3000). A link should appear in your terminal.
95
79
96
80
More information on setting up a local test server is available from [here](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/set_up_a_local_testing_server)
97
81
@@ -108,15 +92,6 @@ conda activate pythia
108
92
conda update --all
109
93
```
110
94
111
-
### Preview the built site on Netlify
112
-
113
-
Once a pull request has passed all tests, including the `preview-site` check, the GitHub bot will post a comment with a preview link on the pull request. You can click on the link to launch a new tab with a build of the Project Pythia site.
0 commit comments