Docs: work through & fix Sphinx build warnings (& occasional error)
@sadielbartholomew đang làm issue này rồi.
Từ ngày 11/3/2024.
Đánh giá
Issue này chưa được đánh giá.
Mô tả
In #34 it was noticed the current docs source material contains numerous issues that throw warnings in the Sphinx build, which should be worked through and remedied. Some of these are indicative of issues in the code itself and not just documentation-related, which are the priority to fix, though it is probably simplest to aim to fix them all at once and if any emerge as more difficult to fix, raise a separate Issue to address later.
Specific issues, copied from console build process resulting in update from #34
$ make html ─╯
python3 -m sphinx -b html -d ../build/doctrees . ../build
Running Sphinx v7.2.6
[autosummary] generating autosummary for: add_cyclic.rst, advanced.rst, axes.rst, axes_plot.rst, bfill.rst, calculate_levels.rst, cbar.rst, cf_data_assign.rst, cf_var_name.rst, check_data.rst, ..., version_2.2.rst, version_2.3.rst, version_2.4.rst, version_3.0.rst, version_3.1.rst, version_3.2.rst, version_3.3.rst, versions.rst, vloc.rst, wrf.rst
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 88 source files that are out of date
updating environment: [new config] 88 added, 0 changed, 0 removed
reading sources... [100%] wrf
/home/slb93/git-repos/cf-plot/docs/source/advanced.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/cbar.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.cf_var_name:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.cf_var_name:17: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/colour_scales.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/con.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.con:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/docs/source/cscale.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.cscale:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.cscale_get_map:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.cscale_get_map:8: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/cylindrical.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/download.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.find_pos_in_array:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.find_pos_in_array:13: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/gclose.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/gopen.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/gpos.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/graphs.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/gset.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/hovmuller.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/hovmuller.rst:6: WARNING: Title underline too short.
Example 10 - latitude-time
-------------------------
/home/slb93/git-repos/cf-plot/docs/source/internal_routines.rst:4: WARNING: toctree contains reference to nonexisting document 'timeaxis'
/home/slb93/git-repos/cf-plot/docs/source/levs.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/lineplot.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.mapaxis:11: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/mapset.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/multiple_plots.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.ndecs:7: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/polar.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.polar_regular_grid:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.polar_regular_grid:14: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/pressure.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.process_color_scales:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.process_color_scales:15: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/projections.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.regrid:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.regrid:12: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/reset.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.reset:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.reset:11: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.rgaxes:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.rgaxes:20: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/rotated_pole.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/rotated_pole.rst:32: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.set_map:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.set_map:12: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/setvars.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.setvars:32: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.setvars:67: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/stipple.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.stipple:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.stipple:21: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/stipple_plots.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/stipple_plots.rst:3: WARNING: duplicate label stipple, other instance in /home/slb93/git-repos/cf-plot/docs/source/stipple.rst
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.stipple_points:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.stipple_points:16: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.stream:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.stream:31: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.supscr:8: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/training.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/traj.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/trajectories.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/trajectories.rst:140: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/docs/source/unstructured.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/user_defined.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/user_guide.rst:476: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/docs/source/user_guide.rst:485: WARNING: Inline substitution_reference start-string without end-string.
/home/slb93/git-repos/cf-plot/docs/source/user_guide.rst:1146: ERROR: Unknown target name: "colorbar".
/home/slb93/git-repos/cf-plot/docs/source/user_guide.rst:585: WARNING: duplicate label trajectories, other instance in /home/slb93/git-repos/cf-plot/docs/source/trajectories.rst
/home/slb93/git-repos/cf-plot/docs/source/user_guide.rst:664: WARNING: duplicate label graphs, other instance in /home/slb93/git-repos/cf-plot/docs/source/graphs.rst
/home/slb93/git-repos/cf-plot/docs/source/vect.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.vect:2: WARNING: Line block ends without a blank line.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.vect:62: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/vectors.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_1.5.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_1.6.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_1.7.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_1.8.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_1.9.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_2.0.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_2.1.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_2.1.rst:49: ERROR: Error in "image" directive:
no content permitted.
.. image:: images/scale1_original.png
:scale: 52%
::
Done
/home/slb93/git-repos/cf-plot/docs/source/version_2.1.rst:94: ERROR: Error in "image" directive:
no content permitted.
.. image:: images/cm.png
:scale: 52%
::
Done
/home/slb93/git-repos/cf-plot/docs/source/version_2.1.rst:160: ERROR: Error in "image" directive:
no content permitted.
.. image:: images/colourscales/BrBG.png
:scale: 52%
::
Done
/home/slb93/git-repos/cf-plot/docs/source/version_2.2.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_2.3.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_2.4.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_3.0.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_3.1.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_3.1.rst:92: WARNING: Title underline too short.
10. cfp.gpos(1) causes stray box lines
=====================================
/home/slb93/git-repos/cf-plot/docs/source/version_3.1.rst:92: WARNING: Title underline too short.
10. cfp.gpos(1) causes stray box lines
=====================================
/home/slb93/git-repos/cf-plot/docs/source/version_3.1.rst:218: WARNING: Title underline too short.
19. cfp.con - improved Z axis detection
======================================
/home/slb93/git-repos/cf-plot/docs/source/version_3.1.rst:218: WARNING: Title underline too short.
19. cfp.con - improved Z axis detection
======================================
/home/slb93/git-repos/cf-plot/docs/source/version_3.2.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/version_3.2.rst:182: WARNING: Title underline too short.
14. cfp.con - ugrid keyword changed to irregular
===============================================
/home/slb93/git-repos/cf-plot/docs/source/version_3.2.rst:182: WARNING: Title underline too short.
14. cfp.con - ugrid keyword changed to irregular
===============================================
/home/slb93/git-repos/cf-plot/docs/source/version_3.3.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/cfplot/cfplot.py:docstring of cfplot.vloc:12: WARNING: Field list ends without a blank line; unexpected unindent.
/home/slb93/git-repos/cf-plot/docs/source/wrf.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/slb93/git-repos/cf-plot/docs/source/advanced.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/colour_scales.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/cylindrical.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/download.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/gallery.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/graphs.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/hovmuller.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/internal_routines.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/issues.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/license.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/multiple_plots.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/older_documentation.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/polar.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/pressure.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/projections.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/rotated_pole.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/routines.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/stipple_plots.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/training.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/trajectories.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/unstructured.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/user_defined.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/user_guide.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/vectors.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version3_changes.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_1.3.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_1.5.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_1.6.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_1.7.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_1.8.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_1.9.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_2.0.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_2.1.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_2.2.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_2.3.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_2.4.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_3.0.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_3.1.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_3.2.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/version_3.3.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/versions.rst: WARNING: document isn't included in any toctree
/home/slb93/git-repos/cf-plot/docs/source/wrf.rst: WARNING: document isn't included in any toctree
done
...
- Ngôn ngữ chính
- Python
- Star
- 21
- Fork
- 11
- Merge trung bình
- 7 giờ 11 phút
- Pull request đã merge (30 ngày)
- 1
Chuẩn bị môi trường
- Không có Dockerfile hay tệp Docker Compose
- Không có mẫu pull request
- Đọc hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của NCAS-CMS/cf-plot
-
testing
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 58/100
-
Add `AGENTS.md` fileĐang mởdocs enhancement
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 64/100
-
Add animation hooks into cf-plotCó thể làm lại được @bnlawrence đã nhận 99 ngày trước và không có pull request nào đang mở. Đang mởenhancement
-
Ugly nemo plotting issueĐang mởbug v35plus
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 45/100
Tất cả issue của NCAS-CMS/cf-plot
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 82/100
RedHatQE/mtv-api-tests#721 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 85/100
pytest-dev/pluggy#757 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 85/100
NousResearch/hermes-agent#134960 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
HTML backend: `<br>` leaks the internal sentinel U+E000 into list items, headings and captionsCó thể đã có người làm @morten-lagabote đã nhận hôm nay. Đang mở
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 67/100
docling-project/docling#4671 ·
Maintainer thường phản hồi trong vòng 1 ngày