Skip to content

Commit 0e829e0

Browse files
Add new section to have a local HTTP server easily
1 parent 844361c commit 0e829e0

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/rustdoc-internals.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,3 +192,18 @@ runtime. These tests don't have as thorough of a writeup, but a broad example
192192
that features results in all tabs can be found in `basic.js`. The basic idea is
193193
that you match a given `QUERY` with a set of `EXPECTED` results, complete with
194194
the full item path of each item.
195+
196+
## Testing locally
197+
198+
Some features of the generated HTML documentation might require the local
199+
storage to be used across pages, which isn't working well without an HTTP
200+
server. To still be able to test these features locally, the best way is to
201+
simply run a local HTTP server, like this:
202+
203+
```bash
204+
$ cd build/[YOUR ARCH]/doc
205+
$ python3 -m http.server
206+
```
207+
208+
Now you can browse your documentation just like you would if it was hosted
209+
on the internet. To get the `std` page index, the URL will be "/std/index.html".

0 commit comments

Comments
 (0)