enthought / enthought/traits

Add etstool task for local documentation viewing?

Open
#1,049 0 comments 0 reactions 0 assignees View on GitHub
component: build component: documentation type: enhancement
Dominant language
Python
Stars
462
Forks
90
PR merge metrics
No merged PRs in 30d

Description

Previously I've been testing documentation builds by building locally with `sphinx-build` and then simply doing `open docs/build/index.html`. But that now runs into browser security precautions: search fails to work properly because it refuses to load content from local files. Instead, the right way to view the documentation is to set up a local HTTP server (which the Python standard library makes a trivial task: just navigate to the directory containing the top-level `index.html` and do `python -m http.server`).

It may be useful to have an `etstool.py` docview task for this.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.