Restructure The Repository to Create The Documentation using Sphinx and Sphinx Gallery #9
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
| @@ -105,3 +105,15 @@ venv.bak/ | |||
|
|
|||
| # Mac OSX | |||
| .DS_Store | |||
|
|
|||
| # Binary files | |||
| *.pickle | |||
There was a problem hiding this comment.
We try to not pickle objects in TARDIS.
| *_examples/ | ||
|
|
||
| # VScode | ||
| .vscode/ |
There was a problem hiding this comment.
Newline at the end of the file.
|
|
||
| # Sphinx HTML Output | ||
| html/ | ||
|
|
There was a problem hiding this comment.
I don't get the sphinx/sphinx gallery folder structure. Could you explain to me?
Usually Sphinx had docs/_build folder where _build was already included in .gitignore.
There was a problem hiding this comment.
I use a command that creates a folder called html. So it should remove this folder
| @@ -10,8 +10,8 @@ supernova: | |||
| distance: 8.32 Mpc | |||
|
|
|||
| # standard atomic data base; get it from the tardis-refdata repository | |||
| atom_data: /home/mew488/src/tardis-refdata/atom_data/kurucz_cd23_chianti_H_He.h5 | |||
| #atom_data: kurucz_cd23_chianti_H_He.h5 | |||
| # atom_data: /home/mew488/src/tardis-refdata/atom_data/kurucz_cd23_chianti_H_He.h5 | |||
There was a problem hiding this comment.
I think you can remove the commented line.
| @@ -0,0 +1,13 @@ | |||
| import requests | |||
There was a problem hiding this comment.
TARDIS has a function to download from URL, maybe works here!
https://github.com/tardis-sn/tardis/blob/master/tardis/io/util.py#L390
|
|
||
| import sys | ||
|
|
||
| sys.path.append("../") |
There was a problem hiding this comment.
this does not look like a sensible idea of implementing things.
There was a problem hiding this comment.
We needed a couple of functions to be used across all the papers. So we needed to put them in a separate folder so that all the files could import them. The only way to access those functions is through this function.
📝 Description
Type: 🚀
featureWrite a complete description of your changes, including the necessary context or any piece of information required to understand your work.
Addition of python scripts to run the configuration files. Then create the documentation structure so that we can build it using the help of Sphinx and Sphinx Gallery.
Also, link issues affected by this pull request by using the keywords:
close,closes,closed,fix,fixes,fixed,resolve,resolvesorresolved.📌 Resources
Examples, notebooks, and links to useful references.
🚦 Testing
How did you test these changes?
Manually running the commands.
☑️ Checklist
build_docslabel