Improve Documentation Site #63
Conversation
|
Implemented; facing some issues where items aren't included in the right |
|
Can we check this? |
|
We're seeing a new |
|
@gvegayon can you remove Markdown checks for Codacy? It's giving a bunch of false positives (e.g. multiple top-level headings despite that being visually optimal and what Quarto outputs). |
|
See #70 for an explanation on why Python |
Since this isn't working, you can download the artifact here. |
|
|
||
| # Installation | ||
|
|
||
| - clone this repository | ||
| - `pip install ./epiworldpy` | ||
| Installation can be preformed through pip (pip installs packages). |
There was a problem hiding this comment.
Typo. "preformed" should be "performed". Might be clearer to simply rewrite this line as "Install epiworld with pip:"
| > dynamics. Furthermore, epiworldR is ideal for simulation studies featuring large | ||
| > populations. | ||
|
|
||
| Current available models: |
There was a problem hiding this comment.
Are all of these available in the python version? Because any models that aren't should be somehow marked as such (indicate only available in C++ but will come to python eventually)
There was a problem hiding this comment.
Good catch. All of these are implemented, except SIRLogit and SIRMixing. Expect a PR later today with these implemented, or with them removed from the list here.
| Computing some key statistics. | ||
|
|
||
| ```{python} | ||
| # ... |
There was a problem hiding this comment.
Is this section supposed to be blank?
There was a problem hiding this comment.
Unsure why that's blank, Computing some key statistics shouldn't actually even be there as it doesn't match up with the R site. Will remove.
|
|
||
| # If extensions (or modules to document with autodoc) are in another directory, | ||
| # add these directories to sys.path here. If the directory is relative to the | ||
| # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| #sys.path.insert(0, os.path.abspath('.')) | ||
| #sys.path.insert(0, os.path.abspath('../src/epiworldpy')) |
There was a problem hiding this comment.
I'm not familiar with Sphinx, so for my own edification, why are so many lines commented like this in this file?
There was a problem hiding this comment.
This is the default Sphinx configuration file that ships with sphinx-quickstart, which I assume is what George used to create the documentation in the first place. The commented out configuration lines are the default behaviour (one other such example of this might be sshd_config(5)). That line is supposed to add a directory to the Python module search path, so the documentation can be generated for HEAD instead of what's installed locally on the system.
I think while setting up the API documentation I un-commented this line (already present in the quickstart), made a change, then realized it didn't work and re-commented it. Looking at the template the quick start uses confirms this theory (sys.path.insert(0, {{ module_path | repr }})). The value in the comment is more accurate to our project structure now, but it may warrant removal due to it not doing anything. Thoughts?
@IsaccBarker I'm not seeing the explanation for Python failing in #70 |
Sorry for the delay, I should have mentioned #71. Off by one, my apologies. |
@IsaccBarker Can you create an issue to fix this? |
IsaccBarker
added
changes requested
|
Blocked until CI actions are updated on |
Fix #60.