Cleanup config files #426
Cleanup config files #426
Conversation
Codecov Report
@@ Coverage Diff @@
## master #426 +/- ##
=======================================
Coverage 91.26% 91.26%
=======================================
Files 60 60
Lines 2815 2815
=======================================
Hits 2569 2569
Misses 246 246
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
I certainly agree... fancy writing the config documentation as part of this? 😁 |
I'm not imagining something massive, just a page on "Configuration" that links to the auto-generated pydantic doc part and explains about the env var... the "use case" sections of the docs will have to expand on why certain options should be set and what they actually do. |
CasperWA
force-pushed
the
cleanup_config_files
branch
from
08413df
to
d86d772
Compare
CasperWA
force-pushed
the
cleanup_config_files
branch
from
d86d772
to
5eb6b73
Compare
CasperWA
force-pushed
the
cleanup_config_files
branch
from
4dfd9c8
to
624aa2e
Compare
New dependency: mkdocs-codeinclude-plugin v0.0.1 This allows the rendition/inclusion of code files, e.g., .py, .json, .yml, etc. This is used in the new configuration site to render `optimade_config.json`. Change docs site name and description from "OPTIMADE-Python-Tools" -> "OPTIMADE Python tools" to align with the README title. Use minify plugin to minify HTML files. Set mkdocstring default_handler explicitly to `python`. Remove configuration section from INSTALL.md. Edit: A later rebase introduced usage of snippets instead.
There is no need for the dependency. I have found out what PyMdown is :) The same can be achieved using PyMdown's Tabbed and Snippets. Furthermore, I have reverted some changes not relevant to this PR.
CasperWA
force-pushed
the
cleanup_config_files
branch
from
624aa2e
to
dc5631a
Compare
Change optimade_config.json maintainer email to dev@optimade.org
Update values and add in the new configuration options as well. The version default_config.json will also be updated now when using the invoke task `setver`. default_config.json has also been added to the bash script `update_docs.sh` run during publishing a new version.
Derived from #420
The only config file we had that works with the servers in this repository was the
tests/test_config.json.This is not very helpful to get this up and running locally to test it out, I think.
Instead I have moved that file to the root and renamed it to
optimade_config.json, removing the other two superfluous config files in the root (example_config.jsonanddefault_config.json), which weren't used for anything other than examples.I'm of the conviction that if the documentation doesn't fully explain the configuration options then a random JSON file is not going to help.
Furthermore, I updated the
tests/test_config.jsonfile to reflect theOptimadeTestClientused, i.e., a single change ofbase_urlto the one used inOptimadeTestClient.The new
optimade_config.jsonis now set as theOPTIMADE_CONFIG_FILEenvironment variable in the CI pytests.We should potentially check that after the tests have run, the environment variable hasn't changed, since that is another goal of some of the tests that checks
config.py; to not tamper with the host environment.Edit: Just found we actually have an issue for this, i.e., closes #310.
Missing (from review):