sandialabs / WecOptTool

WEC Design Optimization Toolbox
https://sandialabs.github.io/WecOptTool/
GNU General Public License v3.0
12 stars 20 forks source link

Dev version of documentation site #347

Closed michaelcdevin closed 1 month ago

michaelcdevin commented 1 month ago

Description

This PR adds the ability to switch between the documentation site for the main (aka latest) and dev branches. For review, see https://michaelcdevin.github.io/WecOptTool for a working example based on my fork (will be removed once this PR is merged).

Type of PR

Checklist for PR

Additional details

I didn't include this here, but this is easily extensible to having documentation for earlier versions of WecOptTool as well; all that is needed is to add the release tags of interest to docs/versions.yaml in display_name: tag format. Let me know if this is of interest.

The docstring edits to wecopttool/utilites.py were included here because they would result in errors in the build process, but strangely only when deploying. I'm not sure why this was not detected before, but will handle it later in a separate issue.

coveralls commented 1 month ago

Pull Request Test Coverage Report for Build 9009810651

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details


Totals Coverage Status
Change from base Build 8978137980: 0.07%
Covered Lines: 2769
Relevant Lines: 2924

💛 - Coveralls