swh:1:snp:340a4c5276a28e0e8a0730602beee2f8d79c28d6
Tip revision: 5c3cf17e85ae83bd187f30da6bd38ce6653be924 authored by Bryna Hazelton on 21 January 2023, 18:43:39 UTC
Ignore B907 error in pre-commit
Ignore B907 error in pre-commit
Tip revision: 5c3cf17
make_index.py
# -*- mode: python; coding: utf-8 -*-
"""
Format the readme.md file into the sphinx index.rst file.
"""
import inspect
import os
import pypandoc
from astropy.time import Time
def write_index_rst(readme_file=None, write_file=None):
t = Time.now()
t.format = "iso"
t.out_subfmt = "date"
out = (
".. pyuvdata documentation top-level file, created by\n"
" make_index.py on {date}\n\n"
).format(date=t.iso)
if readme_file is None:
main_path = os.path.dirname(
os.path.dirname(os.path.abspath(inspect.stack()[0][1]))
)
readme_file = os.path.join(main_path, "README.md")
readme_text = pypandoc.convert_file(readme_file, "rst")
# convert relative links in readme to explicit links
readme_text = readme_text.replace(
"<docs/",
"<https://github.com/RadioAstronomySoftwareGroup/pyuvdata/tree/main/docs/",
)
readme_text = readme_text.replace(
"<.github/",
"<https://github.com/RadioAstronomySoftwareGroup/pyuvdata/tree/main/.github/",
)
out += readme_text
out += (
"\n\nFurther Documentation\n====================================\n"
".. toctree::\n"
" :maxdepth: 1\n\n"
" tutorial\n"
" uvdata\n"
" uvcal\n"
" uvbeam\n"
" uvflag\n"
" utility_functions\n"
" known_telescopes\n"
" developer_docs\n"
)
out.replace("\u2018", "'").replace("\u2019", "'").replace("\xa0", " ")
if write_file is None:
write_path = os.path.dirname(os.path.abspath(inspect.stack()[0][1]))
write_file = os.path.join(write_path, "index.rst")
F = open(write_file, "w")
F.write(out)
print("wrote " + write_file)