Skip to content

Commit 49bda9b

Browse files
authored
Fix warnings in documentation (brucefan1983#778)
* Fixed errors in bibliography file * Removed deprecated call to get_html_theme_path * Fixed duplicate labels
1 parent 261f0cc commit 49bda9b

File tree

8 files changed

+15
-17
lines changed

8 files changed

+15
-17
lines changed

doc/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,7 @@
5050
html_logo = "_static/logo.png"
5151
html_favicon = "_static/logo.ico"
5252
html_theme = 'sphinx_rtd_theme'
53-
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
5453
html_static_path = ['_static']
55-
html_theme_options = {'display_version': True}
5654
html_context = {
5755
'current_version': version,
5856
'versions':

doc/gpumd/output_files/dipole_out.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _dipole_out:
1+
.. _gpumd_dipole_out:
22
.. index::
33
single: dipole.out (output file)
44

doc/gpumd/output_files/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ Output files
4545
- :ref:`active <kw_active>`
4646
- Simulation time and uncertainty during active learning.
4747
- Append
48-
* - :ref:`dipole.out <dipole_out>`
48+
* - :ref:`dipole.out <gpumd_dipole_out>`
4949
- :ref:`dump_dipole <kw_dump_dipole>`
5050
- Predicted dipole.
5151
- Append
52-
* - :ref:`polarizability.out <polarizability_out>`
52+
* - :ref:`polarizability.out <gpumd_polarizability_out>`
5353
- :ref:`dump_polarizability <kw_dump_polarizability>`
5454
- Predicted polarizability.
5555
- Append

doc/gpumd/output_files/polarizability_out.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _polarizability_out:
1+
.. _gpumd_polarizability_out:
22
.. index::
33
single: polarizability.out (output file)
44

doc/nep/output_files/dipole_out.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _dipole_out:
1+
.. _nep_dipole_out:
22
.. index::
33
single: dipole_train.out (output file)
44
single: dipole_test.out (output file)

doc/nep/output_files/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Output files
77
The ``nep`` executable produces several output files.
88
The :ref:`loss.out file <loss_out>` is written in "append mode", while all other files are continuously overwritten.
99

10-
The contents of the :ref:`energy_train.out <energy_out>`, :ref:`force_train.out <force_out_nep>`, :ref:`virial_train.out <virial_out>`, :ref:`stress_train.out <stress_out>`, :ref:`dipole_train.out <dipole_out>`, and :ref:`polarizability_train.out <polarizability_out>` files are updated every 1000 steps, while the contents of the other output files are updated every 100 steps.
10+
The contents of the :ref:`energy_train.out <energy_out>`, :ref:`force_train.out <force_out_nep>`, :ref:`virial_train.out <virial_out>`, :ref:`stress_train.out <stress_out>`, :ref:`dipole_train.out <nep_dipole_out>`, and :ref:`polarizability_train.out <nep_polarizability_out>` files are updated every 1000 steps, while the contents of the other output files are updated every 100 steps.
1111

1212
With the exception of the :ref:`nep.txt file <nep_txt>`, the output files contain only numbers (no text) in matrix form.
1313
All the files are plain text files.
@@ -41,13 +41,13 @@ All the files are plain text files.
4141
- target and predicted stress values for training data set
4242
* - :ref:`stress_test.out <stress_out>`
4343
- target and predicted stress values for test data set
44-
* - :ref:`dipole_train.out <dipole_out>`
44+
* - :ref:`dipole_train.out <nep_dipole_out>`
4545
- target and predicted dipole values for training data set
46-
* - :ref:`dipole_test.out <dipole_out>`
46+
* - :ref:`dipole_test.out <nep_dipole_out>`
4747
- target and predicted dipole values for test data set
48-
* - :ref:`polarizability_train.out <polarizability_out>`
48+
* - :ref:`polarizability_train.out <nep_polarizability_out>`
4949
- target and predicted polarizability values for training data set
50-
* - :ref:`polarizability_test.out <polarizability_out>`
50+
* - :ref:`polarizability_test.out <nep_polarizability_out>`
5151
- target and predicted polarizability values for test data set
5252

5353
.. toctree::

doc/nep/output_files/polarizability_out.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _polarizability_out:
1+
.. _nep_polarizability_out:
22
.. index::
33
single: polarizability_train.out (output file)
44
single: polarizability_test.out (output file)

doc/publications.bib

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -998,19 +998,19 @@ @article{RajFanVae18
998998
}
999999

10001000
@article{RosFraMil23,
1001-
title = {Anharmonicity of the antiferrodistortive soft mode in barium zirconate ${\mathrm{BaZrO}}_{3}$},
1001+
title = {Anharmonicity of the antiferrodistortive soft mode in barium zirconate BaZrO$_3$},
10021002
author = {Rosander, Petter and Fransson, Erik and Milesi-Brault, Cosme and Toulouse, Constance and Bourdarot, Fr\'ed\'eric and Piovano, Andrea and Bossak, Alexei and Guennou, Mael and Wahnstr\"om, G\"oran},
10031003
journal = {Phys. Rev. B},
10041004
volume = {108},
10051005
pages = {014309},
10061006
year = {2023},
1007-
doi = {10.1103/PhysRevB.108.014309}
1007+
doi = {10.1103/PhysRevB.108.014309},
10081008
}
10091009

10101010
@article{RuQiSun24,
10111011
author = {Ru, Guoliang and Qi, Weihong and Sun, Shu and Tang, Kewei and Du, Chengfeng and Liu, Weimin},
10121012
title = {Interlayer Friction and Adhesion Effects in Penta-PdSe2-Based van der Waals Heterostructures},
1013-
year = {2024}
1013+
year = {2024},
10141014
journal = {Advanced Science},
10151015
volume = {11},
10161016
number = {34},
@@ -1025,7 +1025,7 @@ @article{ShaDaiChe22
10251025
journal = {Diamond and Related Materials},
10261026
volume = {129},
10271027
pages = {109341},
1028-
doi = {10.1016/j.diamond.2022.109341}
1028+
doi = {10.1016/j.diamond.2022.109341},
10291029
}
10301030

10311031
@article{ShaDaiChe23,

0 commit comments

Comments
 (0)