BUG: docstring sphinx warnings

[aburrell]

Description

Compiling the docs locally will show formatting errors in the docstrings that can result in incorrect or hard-to-read documentation.

To Reproduce this bug:

Steps to reproduce the behavior:

1. Go to the 'docs' directory of your local repository
2. Compile the documentation: make html
3. See error in the red text

Output from my computer is shown in the Additional context section

Test configuration

• OS: OS X Big Sur
• Version: Python 3.9
• Other details about your setup that could be relevant

Additional context

/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.calc_mlat_rings:7: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.calc_mlat_rings:8: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.calc_mlat_rings:10: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:11: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:28: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:1: WARNING: duplicate object description of conjugate_map.conjcalc, other instance in api, use :no-index: for one of them
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:11: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:28: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.calc_mlat_rings:7: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.calc_mlat_rings:8: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.calc_mlat_rings:10: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:11: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:13: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:28: WARNING: Definition list ends without a blank line; unexpected unindent.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.findconj:10: ERROR: Unexpected indentation.
/Users/aburrell/Programs/Git/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.findconj:12: WARNING: Block quote ends without a blank line; unexpected unindent.

[KCollins]

Down to one new error:

pliny@Pliny:~/Documents/Space Science Institute/PGC Geomagnetic Conjugate Map/conjugate_map/docs$ make html
Running Sphinx v7.4.7
loading translations [en]... done
making output directory... done
[autosummary] generating autosummary for: api.rst, index.rst, usage.rst
loading intersphinx inventory 'rtd' from https://docs.readthedocs.io/en/stable/objects.inv...
loading intersphinx inventory 'python' from https://docs.python.org/3/objects.inv...
loading intersphinx inventory 'sphinx' from https://www.sphinx-doc.org/en/master/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 3 source files that are out of date
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [100%] usage
/mnt/c/Users/kvc2/Documents/Space Science Institute/PGC Geomagnetic Conjugate Map/conjugate_map/conjugate_map/conj_calc.py:docstring of conjugate_map.conj_calc.conjcalc:1: WARNING: duplicate object description of conjugate_map.conjcalc, other instance in api, use :no-index: for one of them
/mnt/c/Users/kvc2/Documents/Space Science Institute/PGC Geomagnetic Conjugate Map/conjugate_map/docs/index.rst:1: CRITICAL: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: '../README.rst'.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets...
copying static files... done
copying extra files... done
copying assets: done
writing output... [100%] usage
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done

====================== slowest reading durations =======================
0.644 api
0.009 index
0.007 usage
build succeeded, 2 warnings.

The HTML pages are in _build/html.