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

Restructure readthedocs #853

Merged
merged 14 commits into from
Apr 13, 2021
Prev Previous commit
Next Next commit
Modify conf.py to copy the setup part of the readme
Bachibouzouk committed Apr 13, 2021
commit a51efa18766bca79dc4ecef01f4bd0fb631d4a26
6 changes: 5 additions & 1 deletion docs/Installation.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. _installation-steps:

.. include:: ../README.rst
============
Installation
============

.. include:: readme.inc
17 changes: 14 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
@@ -170,13 +170,24 @@ def generate_parameter_table(input_csv_file, output_csv_file):
)


generate_parameter_description("MVS_parameters_list.csv", "MVS_parameters_list.inc")
generate_parameter_table("MVS_parameters_list.csv", "MVS_parameters_list.tbl")
def copy_readme():
with open("../README.rst", "r") as fp:
Bachibouzouk marked this conversation as resolved.
Show resolved Hide resolved
data = fp.readlines()
with open("readme.inc", "w") as fp:
fp.writelines(data[data.index("Setup\n"):])




generate_parameter_description("MVS_parameters_list.csv",
"model/parameters/MVS_parameters_list.inc")
generate_parameter_table("MVS_parameters_list.csv", "model/parameters/MVS_parameters_list.tbl")
generate_parameter_categories(
"MVS_parameters_list.csv",
"MVS_parameters_categories.csv",
"MVS_parameters_categories.inc",
"model/parameters/MVS_parameters_categories.inc",
)
copy_readme()

# -- Project information -----------------------------------------------------