Skip to content

Comments

Sphinx Documentation Build Issue#890

Merged
ksbeattie merged 3 commits intoIDAES:mainfrom
bpaul4:doc-build-issue
Jun 9, 2022
Merged

Sphinx Documentation Build Issue#890
ksbeattie merged 3 commits intoIDAES:mainfrom
bpaul4:doc-build-issue

Conversation

@bpaul4
Copy link
Contributor

@bpaul4 bpaul4 commented Jun 7, 2022

Fixes

  • Recently, test runs have been failing due to Sphinx documentation build errors:
    142 WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid langauge code. Falling back to 'en' (English).
    ... long list of deprecated import path warnings (see Local Documentation Build Warnings #883 ) ...
    872 /home/runner/work/idaes-pse/idaes-pse/docs/tutorials/tutorials_examples.rst:3: WARNING: unknown document: howto/index
  • The first warning is related to Sphinx Issue #10474 and PR #10481 where None was removed as a supported flag for the language entry. This update switches the flag to 'en' (the new default) to remove the first warning and fixes the path reference in the second warning.

Summary/Motivation:

Changes proposed in this PR:

Legal Acknowledgement

By contributing to this software project, I agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the license terms described in the LICENSE.txt file at the top level of this directory.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

@bpaul4 bpaul4 self-assigned this Jun 7, 2022
@codecov
Copy link

codecov bot commented Jun 7, 2022

Codecov Report

Merging #890 (7206744) into main (6bdf3db) will decrease coverage by 0.00%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #890      +/-   ##
==========================================
- Coverage   69.50%   69.49%   -0.01%     
==========================================
  Files         578      578              
  Lines       64859    64859              
  Branches    12064    12064              
==========================================
- Hits        45080    45077       -3     
- Misses      17508    17512       +4     
+ Partials     2271     2270       -1     
Impacted Files Coverage Δ
idaes/ver.py 61.53% <0.00%> (-4.62%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6bdf3db...7206744. Read the comment docs.

@bpaul4 bpaul4 marked this pull request as ready for review June 7, 2022 15:23
Copy link
Member

@ksbeattie ksbeattie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ksbeattie ksbeattie enabled auto-merge (squash) June 9, 2022 18:30
@ksbeattie ksbeattie added the Priority:High High Priority Issue or PR label Jun 9, 2022
@ksbeattie ksbeattie disabled auto-merge June 9, 2022 18:30
@ksbeattie ksbeattie merged commit cccb331 into IDAES:main Jun 9, 2022
bpaul4 added a commit to MAZamarripa/idaes-pse that referenced this pull request Jul 18, 2022
* Sphinx Documentation Build Issue (IDAES#890)

* switch lang flag to 'en'

* Flag formatting

* Update path reference

* updating power plant capcost and QGESS tests to run as expected

* bring over MEA_CCS updates and tests

* running black on costing/ directory

* move custom dicts to new file

* fix some spacing causing doc build errors

* Replace method calls with UnitModelCostingBlocks

* Running black on the entire repo (IDAES#894)

* Running black on the entire repo

* Add pinned requirement for Black stable version

* Add CI check to ensure code is Black-formatted

Co-authored-by: Ludovico Bianchi <[email protected]>

* Fix PySMO tests (IDAES#903)

* Minor change to trigger tests

* Added abs to tolerance check

* Run black

* Remove string comparison

* Tighten tolerance

* Fixed kriging test by removing variable dependence

* bring in report method updates

* bring in more MEA CCS updates

* Add check on total TPC

* final formatting fixes

* Update report method

Adding cost of electricity and cost of capture to report method

* Black reformatting

* Update report method

Fixing units of cost of electricity

Co-authored-by: Keith Beattie <[email protected]>
Co-authored-by: Ludovico Bianchi <[email protected]>
Co-authored-by: OOAmusat <[email protected]>
Co-authored-by: Daison2102 <[email protected]>
andrewlee94 pushed a commit that referenced this pull request Oct 14, 2022
* updating power plant costing to new costing framework

* updating power plant capcost and QGESS tests to run as expected

* bring over MEA_CCS updates and tests

* running black on costing/ directory

* move custom dicts to new file

* fix some spacing causing doc build errors

* Replace method calls with UnitModelCostingBlocks

* bring in report method updates

* bring in more MEA CCS updates

* Add check on total TPC

* final formatting fixes

* Update report method

Adding cost of electricity and cost of capture to report method

* Black reformatting

* Update report method

Fixing units of cost of electricity

* Fixing test issues, bringing in MEA_CCS code (#1)

* Sphinx Documentation Build Issue (#890)

* switch lang flag to 'en'

* Flag formatting

* Update path reference

* updating power plant capcost and QGESS tests to run as expected

* bring over MEA_CCS updates and tests

* running black on costing/ directory

* move custom dicts to new file

* fix some spacing causing doc build errors

* Replace method calls with UnitModelCostingBlocks

* Running black on the entire repo (#894)

* Running black on the entire repo

* Add pinned requirement for Black stable version

* Add CI check to ensure code is Black-formatted

Co-authored-by: Ludovico Bianchi <[email protected]>

* Fix PySMO tests (#903)

* Minor change to trigger tests

* Added abs to tolerance check

* Run black

* Remove string comparison

* Tighten tolerance

* Fixed kriging test by removing variable dependence

* bring in report method updates

* bring in more MEA CCS updates

* Add check on total TPC

* final formatting fixes

* Update report method

Adding cost of electricity and cost of capture to report method

* Black reformatting

* Update report method

Fixing units of cost of electricity

Co-authored-by: Keith Beattie <[email protected]>
Co-authored-by: Ludovico Bianchi <[email protected]>
Co-authored-by: OOAmusat <[email protected]>
Co-authored-by: Daison2102 <[email protected]>

* costing updates

* costing updates

* improving generic variable O&M costs calculation

* Updating currency and basis unit handling, other minor fixes

* Zipping together costing dictionaries

* Improvements from review comments

* Updating tests for new changes

* Updating author tags

* Removing QGESS tests, updating NGCC tests, adding capcost tests, param unit fixes

* Sort author list

* General improvements and cost variable unit corrections

* Removing deprecated default arguments

* Addressing most review comments

* Addressing more review comments

* Testing and coverage improvements

* Resolving pylint and directory reference issues

* Separating power plant currency units

* cleaning up comments

* Final fixes from review comments

* Add some checks to json regeneration test

Co-authored-by: Miguel Zamarripa-Perez <[email protected]>
Co-authored-by: Daison2102 <[email protected]>
Co-authored-by: Keith Beattie <[email protected]>
Co-authored-by: Ludovico Bianchi <[email protected]>
Co-authored-by: OOAmusat <[email protected]>
@bpaul4 bpaul4 deleted the doc-build-issue branch August 18, 2023 16:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority:High High Priority Issue or PR

Projects

No open projects

Development

Successfully merging this pull request may close these issues.

2 participants