Skip to content

Documentation for hexrdgui at hexrdgui.readthedocs.io

Notifications You must be signed in to change notification settings

HEXRD/hexrdgui-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

This repository hosts HEXRDGUI documentation using the MkDocs package. It can be built locally, and it is also hosted on readthedocs. To contribute, please fork the repository, create a feature branch, and open a pull request.

Building Locally

First clone the repository, and then get your environment set up.

git clone git://github.com/hexrd/hexrdgui-docs
cd hexrdgui-docs

Using Python 3, run the following commands to install the documentation requirements and start the server:

pip install -r requirements.txt
mkdocs serve -a localhost:8089

This will set up a local server on port 8089 which you can view in your preferred browser at: http://localhost:8089/.

Alternatively, you may run the serve.sh script, which does essentially the same thing.

Kitware, Inc.

About

Documentation for hexrdgui at hexrdgui.readthedocs.io

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages