Skip to content

Commit

Permalink
docs(*): prepare directory for GitHub pages
Browse files Browse the repository at this point in the history
Setup to publish to GitHub pages per
sphinx-doc/sphinx#3382 (comment)
  • Loading branch information
weibullguy committed Jun 22, 2019
1 parent e8de57f commit 40fdaf7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 43 deletions.
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@
[![Github](https://img.shields.io/github/release/ReliaQualAssociates/ramstk/all.svg)](https://github.com/ReliaQualAssociates/ramstk/releases)
[![PyPI](https://img.shields.io/pypi/v/RAMSTK.svg)](https://pypi.python.org/pypi/RAMSTK/)
[![Master Build Status](https://travis-ci.org/ReliaQualAssociates/ramstk.svg?branch=master)](https://travis-ci.org/ReliaQualAssociates/ramstk)
[![Develop Build Status](https://travis-ci.org/ReliaQualAssociates/ramstk.svg?branch=develop)](https://travis-ci.org/ReliaQualAssociates/ramstk)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/281487d67cff4b7a8fd7bd4ef878a45e)](https://www.codacy.com/app/ReliaQualAssociates/ramstk?utm_source=github.com&utm_medium=referral&utm_content=ReliaQualAssociates/ramstk&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/281487d67cff4b7a8fd7bd4ef878a45e)](https://www.codacy.com/app/ReliaQualAssociates/ramstk?utm_source=github.com&utm_medium=referral&utm_content=ReliaQualAssociates/ramstk&utm_campaign=Badge_Coverage)
[![Coverage Status](https://coveralls.io/repos/github/ReliaQualAssociates/ramstk/badge.svg?branch=master)](https://coveralls.io/github/ReliaQualAssociates/ramstk?branch=master)
[![CodeFactor](https://www.codefactor.io/repository/github/reliaqualassociates/ramstk/badge)](https://www.codefactor.io/repository/github/reliaqualassociates/ramstk)
[![BCH Compliance](https://bettercodehub.com/edge/badge/ReliaQualAssociates/ramstk?branch=master)](https://bettercodehub.com/)
[![Documentation Status](https://readthedocs.org/projects/ramstk/badge/?version=latest)](https://ramstk.readthedocs.io/en/latest/?badge=latest)

## 🚩 Table of Contents
- [Features](#-features)
Expand All @@ -20,7 +18,7 @@
- [Download](#download)
- [Running the Tests](#running-the-tests)
- [Usage](#-usage)
- [Docs](#-docs)
- [Documentation](#-docs)
- [Examples](#-examples)
- [Contributing](#-contributing)
- [Authors](#-authors)
Expand Down Expand Up @@ -104,14 +102,6 @@ $ pytest -m integration tests/modules/test_allocation.py
$ pytest -m calculation tests/analyses/prediction
```

#### Coding Style Tests

The test directory contains a script named RunTests.py. This is for executing static checkers such as pylint and is intended for developers. It makes it easier to integrate into an IDE. You can execute the following to see what RunTests.py wraps:

```
$ tests/RunTests.py --help
```

## 🔨 Usage

After installing RAMSTK, it can be launched from a terminal emulator:
Expand Down
Empty file added docs/.nojekyll
Empty file.
40 changes: 8 additions & 32 deletions docs/api/gui/gtk.matrixview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,57 +11,33 @@ Matrix View Meta-Class
:private-members:
:show-inheritance:

Function-Hardware Matrix View
Function Matrix Views
-------------------------------------------------------------------------------
.. automodule:: ramstk.gui.gtk.matrixviews.FunctionHardware
.. automodule:: ramstk.gui.gtk.matrixviews.Function
:members:
:undoc-members:
:private-members:
:show-inheritance:

Hardware-Requirement Matrix View
Requirement Matrix Views
-------------------------------------------------------------------------------
.. automodule:: ramstk.gui.gtk.matrixviews.HardwareRequirement
.. automodule:: ramstk.gui.gtk.matrixviews.Requirement
:members:
:undoc-members:
:private-members:
:show-inheritance:

Hardware-Validation Matrix View
Hardware Matrix Views
-------------------------------------------------------------------------------
.. automodule:: ramstk.gui.gtk.matrixviews.HardwareValidation
.. automodule:: ramstk.gui.gtk.matrixviews.Hardware
:members:
:undoc-members:
:private-members:
:show-inheritance:

Requirement-Hardware Matrix View
Validation Matrix Views
-------------------------------------------------------------------------------
.. automodule:: ramstk.gui.gtk.matrixviews.RequirementHardware
:members:
:undoc-members:
:private-members:
:show-inheritance:

Requirement-Validation Matrix View
-------------------------------------------------------------------------------
.. automodule:: ramstk.gui.gtk.matrixviews.RequirementValidation
:members:
:undoc-members:
:private-members:
:show-inheritance:

Validation-Hardware Matrix View
-------------------------------------------------------------------------------
.. automodule:: ramstk.gui.gtk.matrixviews.ValidationHardware
:members:
:undoc-members:
:private-members:
:show-inheritance:

Validation-Requirement Matrix View
-------------------------------------------------------------------------------
.. automodule:: ramstk.gui.gtk.matrixviews.ValidationRequirement
.. automodule:: ramstk.gui.gtk.matrixviews.Validation
:members:
:undoc-members:
:private-members:
Expand Down

0 comments on commit 40fdaf7

Please sign in to comment.