Skip to content

Commit b753b42

Browse files
authored
Merge pull request #302 from ExaWorks/add_note_for_viewing_built_docs
Added a note that warns agains using file:// to view the docs after b…
2 parents 033403a + 463285d commit b753b42

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README-dev.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ There are two ways to build the documentation. One is the plain one, where
66
the plain Sphinx output is desired, and the other is the themed version that
77
is meant to integrate with the web site.
88

9+
!!! Note
10+
11+
When viewing the built docs locally, using the `file://` protocol results
12+
in cross-scripting issues that prevent the correct display of the
13+
resulting pages, such as pages being cut off at the bottom. Please use
14+
a simple http server as detailed below.
15+
916
### Building the Standalone Documentation
1017

1118
1. Make sure you have the documentation dependencies installed:

0 commit comments

Comments
 (0)