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

docs: update rtd to use sphinxcontrib-bibtex v2.0.0 and later #1019

Merged
merged 1 commit into from
Mar 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,17 @@ def runDoxygen(sourcfile, doxyfileIn, doxyfileOut):
'sphinxcontrib.bibtex',
'sphinxcontrib.mermaid',
]
bibtex_bibfiles = [
'source/user/aerodyn-aeroacoustics/references.bib',
'source/user/aerodyn-olaf/bibliography.bib',
'source/user/aerodyn/bibliography.bib',
'source/user/beamdyn/references.bib',
'source/user/extptfm/bibliography.bib',
'source/user/fast.farm/bibliography.bib',
'source/user/hydrodyn/references.bib',
'source/user/servodyn-stc/StC_Refs.bib',
'source/user/subdyn/references_SD.bib'
]

autodoc_default_flags = [
'members',
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ docutils==0.16
Pygments>=2.2
pyparsing>=2.1
Sphinx>=1.8.5
sphinxcontrib-bibtex>=0.3.3,<2.0.0
sphinxcontrib-bibtex>=2.0.0
sphinxcontrib-doxylink>=1.3
sphinxcontrib-mermaid>=0.6
sphinx_rtd_theme>=0.3
Expand Down
38 changes: 19 additions & 19 deletions docs/source/user/aerodyn-aeroacoustics/references.bib
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@article{Amiet:1975,
@article{aa-Amiet:1975,
author= {Roy K. Amiet},
title= {Acoustic Radiation from an Airfoil in a Turbulent Stream},
journal= {Journal of Sound and Vibration},
Expand All @@ -9,15 +9,15 @@ @article{Amiet:1975
doi= {10.1016/S0022-460X(75)80105-2}
}

@techreport{Bortolotti:2019,
@techreport{aa-Bortolotti:2019,
author= {Pietro Bortolotti and Helena Canet Tarres and Katherine Dykes and Karl Merz and Latha Sethuraman and David Verelst and Frederik Zahle},
year= {2019},
title= {Systems Engineering in Wind Energy - WP2.1 Reference Wind Turbines},
institution= {IEA Technical Report},
URL= {https://www.nrel.gov/docs/fy19osti/73492.pdf}
}

@techreport{Brooks:1989,
@techreport{aa-Brooks:1989,
author= {Thomas F. Brooks and D. Stuart Pope and Michael A. Marcolini},
year= {1989},
title= {Airfoil Self-Noise and Prediction},
Expand All @@ -26,7 +26,7 @@ @techreport{Brooks:1989
number= { 1218}
}

@article{Drela:1987,
@article{aa-Drela:1987,
author = {Drela, Mark and Giles, Michael B.},
title = {Viscous-inviscid analysis of transonic and low Reynolds number airfoils},
journal = {AIAA Journal},
Expand All @@ -37,7 +37,7 @@ @article{Drela:1987
doi = {10.2514/3.9789},
}

@inproceedings{Guidati:1997,
@inproceedings{aa-Guidati:1997,
author = {Gianfranco Guidati and Rainer Bareiss and Siegfried Wagner and Rene Parchen and Gianfranco Guidati and Rainer Bareiss and Siegfried Wagner and Rene Parchen},
title = {Simulation and measurement of inflow-turbulence noise on airfoils},
booktitle = {3rd AIAA/CEAS Aeroacoustics Conference},
Expand All @@ -46,7 +46,7 @@ @inproceedings{Guidati:1997
}


@article{Lowson:1970,
@article{aa-Lowson:1970,
author= {Martin V. Lowson},
year= {1970},
title= {Theoretical Analysis of Compressor Noise Evaluation},
Expand All @@ -56,7 +56,7 @@ @article{Lowson:1970
doi= {10.1121/1.1911508}
}

@article{Klein:2018,
@article{aa-Klein:2018,
author= {Levin Klein and Jonas Gude and Florian Wenz and Thorsten Lutz and Ewald Krämer},
year= {2018},
title= {Advanced Computational Fluid Dynamics (CFD)–Multi-Body Simulation (MBS) Coupling to Assess Low-Frequency Emissions from Wind Turbines},
Expand All @@ -66,7 +66,7 @@ @article{Klein:2018
doi= {10.5194/wes-3-713-2018}
}

@techreport{MoriartyMigliore:2003,
@techreport{aa-MoriartyMigliore:2003,
author= {Patrick J. Moriarty and Paul G. Migliore},
year= {2003},
title= {Semi-Empirical Aeroacoustic Noise Prediction Code for Wind Turbines},
Expand All @@ -76,23 +76,23 @@ @techreport{MoriartyMigliore:2003
URL= {https://www.nrel.gov/docs/fy04osti/34478.pdf}
}

@inproceedings{MoriartyGuidatiMigliore:2004,
@inproceedings{aa-MoriartyGuidatiMigliore:2004,
author = {Patrick Moriarty and Gianfranco Guidati and Paul Migliore},
title = {Recent Improvement of a Semi-Empirical Aeroacoustic Prediction Code for Wind Turbines},
booktitle = {10th AIAA/CEAS Aeroacoustics Conference},
year= {2004},
doi = {10.2514/6.2004-3041}
}

@inproceedings{MoriartyGuidatiMigliore:2005,
@inproceedings{aa-MoriartyGuidatiMigliore:2005,
author = {Patrick Moriarty and Gianfranco Guidati and Paul Migliore},
title = {Prediction of Turbulent Inflow and Trailing-Edge Noise for Wind Turbines},
booktitle = {11th AIAA/CEAS Aeroacoustics Conference},
year = {2005},
doi = {10.2514/6.2005-2881}
}

@techreport{MoriartyHansen:2005,
@techreport{aa-MoriartyHansen:2005,
author= {Patrick J. Moriarty and A. C. Hansen},
year= {2005},
title= {AeroDyn Theory Manual},
Expand All @@ -102,7 +102,7 @@ @techreport{MoriartyHansen:2005
URL= {https://www.nrel.gov/docs/fy05osti/36881.pdf}
}

@techreport{Moriarty:2005,
@techreport{aa-Moriarty:2005,
author= { Patrick J. Moriarty},
year= {2005},
title= {NAFNoise User's Guide},
Expand All @@ -111,29 +111,29 @@ @techreport{Moriarty:2005
URL= {https://github.com/NREL/NAFNoise/blob/master/NAFNoise.pdf}
}

@misc{xfoil:699,
@misc{aa-xfoil:699,
author= {Mark Drela},
title= {{XF}oil, release 6.99},
url= {https://web.mit.edu/drela/Public/web/xfoil/}
}

@misc{openfast:2019,
@misc{aa-openfast:2019,
title= {Open{FAST}, dev branch},
year= {2019},
publisher= {GitHub},
journal= {GitHub repository},
url= {https://github.com/OpenFAST/openfast}
}

@techreport{Parchen:1998,
@techreport{aa-Parchen:1998,
author= {René R. Parchen},
year= {1998},
title= {Progress Report {DRAW}: A Prediction Scheme for Trailing Edge Noise Based on Detailed Boundary Layer Characteristics},
institution= {TNO Institute of Applied Physics}
}


@inproceedings{Paterson:1976,
@inproceedings{aa-Paterson:1976,
author = {R. Paterson and R. Amiet},
title = {Acoustic radiation and surface pressure characteristics of an airfoil due to incident turbulence},
booktitle = {3rd Aeroacoustics Conference},
Expand All @@ -144,7 +144,7 @@ @inproceedings{Paterson:1976
doi = {10.2514/6.1976-571}
}

@article{Sucameli:2018,
@article{aa-Sucameli:2018,
doi = {10.1088/1742-6596/1037/2/022038},
year = 2018,
month = {jun},
Expand All @@ -158,7 +158,7 @@ @article{Sucameli:2018
}


@techreport{Viterna:1981,
@techreport{aa-Viterna:1981,
author= {Larry A. Viterna},
year= {1981},
title= {Method for Predicting Impulsive Noise Generated by Wind Turbine Rotors},
Expand All @@ -169,7 +169,7 @@ @techreport{Viterna:1981



@article{Zhu:2005,
@article{aa-Zhu:2005,
author= {Wei J. Zhu and Nicolai Heilskov and Wen Zhong Shen},
year= {2005},
title= {Modeling of Aerodynamically Generated Noise From Wind Turbines},
Expand Down
1 change: 0 additions & 1 deletion docs/source/user/aerodyn-aeroacoustics/refs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@

.. bibliography:: references.bib
:labelprefix: aa-
:keyprefix: aa-


Loading