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.

Sign up for GitHub

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

Jump to bottom

Add sphinx documentation to Github Pages #11

Open
CFlaniganMide opened this issue Jul 22, 2020 · 0 comments
Open

Add sphinx documentation to Github Pages #11

CFlaniganMide opened this issue Jul 22, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@CFlaniganMide
Copy link
Contributor

This one has a few steps, we may want to separate it into multiple issues.

  • Our documentation needs some updating, mostly just adding examples into the docs themselves.
  • Sphinx has a very easy system to generate HTML documentation.
    • Standardize the script for calling it
    • Check out a few more themes before we stick with the one we have. I feel like it's not utilizing color and weight very effectively with the defaults
  • Github pages has easy integration to allow you to your content pretty dynamically. There's a switch we can flip, once the docs are up to date and in the main branch, and it'll just be hosted.
@CFlaniganMide CFlaniganMide added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 22, 2020
CrepeGoat added a commit that referenced this issue Oct 13, 2020
@CrepeGoat
Revert "Merge pull request #11 from MideTechnology/feature/10_parser-…
aeff0ad 
…optimization"

This reverts commit a045a8e, reversing
changes made to aefe43d.
CrepeGoat added a commit that referenced this issue Oct 13, 2020
@CrepeGoat
Revert "Revert "Merge pull request #11 from MideTechnology/feature/10…
d16cd99 
…_parser-optimization""

This reverts commit aeff0ad.

The original reversion confirms that the issue is not related to
archive/#11; with that confirmed, the original reversion may be removed
CrepeGoat added a commit that referenced this issue Oct 14, 2020
@CrepeGoat
Fix/pressure parser error (#17)
e7d8b68 
* added an integration tests revealing parser bug

* Revert "Merge pull request #11 from MideTechnology/feature/10_parser-optimization"

This reverts commit a045a8e, reversing
changes made to aefe43d.

* Revert "Revert "Merge pull request #11 from MideTechnology/feature/10_parser-optimization""

This reverts commit aeff0ad.

The original reversion confirms that the issue is not related to
archive/#11; with that confirmed, the original reversion may be removed

* removed code causing deprecation warnings

* manually specified in numpy parser standardized mapping from struct to numpy typestrings

* added sanity checks for integrity of typestring conversions

* moved typestring assertion to unit tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@CFlaniganMide