Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Github Pages Documentation #63

Closed
wants to merge 32 commits into from
Closed
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
ef48fd5
Initial gh-pages setup, with skeleton layout and local build instruct…
H0R5E Mar 24, 2020
b44d3e6
Update gitignore for leftovers from master branch
H0R5E Mar 25, 2020
38fe5fa
Add robust method to get source code and auto documentation
H0R5E Mar 25, 2020
28c92ad
Update front matter
H0R5E Mar 25, 2020
6be94eb
Add installation guide
H0R5E Mar 25, 2020
aa043a8
Start example documentation
H0R5E Mar 25, 2020
6fce53c
don't track internal copy of master
ryancoe Mar 25, 2020
a072128
add makefile for OSX (UNIX too?) and update README instructions
ryancoe Mar 25, 2020
b210a0a
add funding statement
ryancoe Mar 25, 2020
60bce25
fix to previous commit
ryancoe Mar 25, 2020
5920b7a
complete draft of example page
ryancoe Mar 25, 2020
9326e93
A little tidying and add links to the API for the geom and control su…
H0R5E Mar 25, 2020
0d2faa2
add licensing and copyright information
ryancoe Mar 25, 2020
42c3952
fix error in what the code name is :)
ryancoe Mar 25, 2020
7711ada
Tidying
H0R5E Mar 26, 2020
d1bc705
Fix conda deactivate command
H0R5E Mar 26, 2020
0b355fb
Fixes to the installation instructions
H0R5E Mar 26, 2020
4e58b76
add citations for controllers
ryancoe Mar 26, 2020
2c6f270
add link for RM3
ryancoe Mar 26, 2020
7d19869
expand on design variable bounds and x0
ryancoe Mar 26, 2020
d7376f8
explain single scalar design variable more fully
ryancoe Mar 26, 2020
7f50b08
Basic citations can't be numeric
H0R5E Mar 26, 2020
7966e28
add image of RM3 dimensions to example docs
ryancoe Mar 26, 2020
2e9955c
Merge branch 'new_gh_pages' of github.com:H0R5E/WecOptTool into new_g…
ryancoe Mar 26, 2020
2ab244a
credit developers
ryancoe Mar 26, 2020
c7f4515
add workflow diagram and description
ryancoe Mar 26, 2020
e6e40cd
justified section text
ryancoe Mar 26, 2020
d10036a
add plot of spectra to example docs
ryancoe Mar 26, 2020
e3c4bf3
Downgrade Sphinx and add note about docstring formatting to README
H0R5E Mar 27, 2020
5e24ea1
Add unistallation instructions
H0R5E Mar 27, 2020
42addc2
Fix line numbering in example
H0R5E Mar 27, 2020
e29591b
Add short descriptions to API
H0R5E Mar 27, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# sphinx build folder
_build

# internal copy of master branch
git_src/

# Compiled source #
###################
*.com
*.class
*.dll
*.exe
*.o
*.so

# Packages #
############
# it's better to unpack these files and commit the raw source
# git has its own built in compression methods
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# Logs and databases #
######################
*.log
*.sql
*.sqlite

# OS generated files #
######################
.DS_Store?
ehthumbs.db
Icon?
Thumbs.db

# Editor backup files #
#######################
*~

# NEMOH #
#########
~nemoh_runs/

# Tests #
#########
test_results/
test_results.pdf
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,41 @@
# WecOptTool Documentation

## Compile Instructions

### Setup Sphinx (One Time Only)

Install [Anaconda Python](https://www.anaconda.com/distribution/)

Create the Sphinx environment

```
> conda create -n _sphinx pip sphinx sphinx_rtd_theme colorama future
> activate _sphinx
(_sphinx) > pip install sphinxcontrib-matlabdomain
(_sphinx) > conda deactivate
>
```

### Build Locally
The make process clones a copy of the master branch and then uses this to quote snippets of code.
Docs are built in the `_build` directory.

#### Windows
This uses the instructions in `make_www_local.bat`.

```
> cd path/to/WecOptTool
> make_www_local
```

#### OSX
This uses the instructions in `makefile`.

```bash
> cd path/to/WecOptTool
> make html
```

## License

[CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
13 changes: 13 additions & 0 deletions _static/theme_overrides.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
/* override table width restrictions */
@media screen and (min-width: 767px) {

.wy-table-responsive table td {
/* !important prevents the common CSS stylesheets from overriding
this as on RTD they are loaded after this stylesheet */
white-space: normal !important;
}

.wy-table-responsive {
overflow: visible !important;
}
}
Loading