The Jupyter Book documentation needs to be improved

[rickecon]

The current format of the documentation in the ./docs/ folder needs to be improved. We need to update the current structure, but I am happy to leave that for another issue. For this issue, I just want to get the current documentation structure rendering properly. The documentation for Jupyter Books is here: https://jupyterbook.org/.

• [ ] Fix how the current documentation is rendering. The current documentation should look like the PolicyEngine-US documentation. But you can see what ours currently looks like by navigating to the fiscalsim-us folder, activating the conda environment (conda activate fiscalsim-us), installing Jupyter Book (pip install jupyter-book), building the documentation (jb build ./docs), then opening the index file in your browser (./docs/_build/html/index.html). Below is a screenshot of the current state, which we don't want.

  

• [ ] Add a theme that is similar to OG-Core JB documentation and PolicyEngine-US's furo theme. I like the PolicyEngine Jupyter Book ability to go light and dark mode (default light). But it would be nice to look a little different from the PolicyEngine Jupyter Book documentation. Here is a section in the Jupyter Book documentation entitled "Choose a custom Sphinx theme". But we might just want the Sphinx Book Theme because "[w]hile you may choose any theme, there is some Jupyter Book configuration that only works with the Sphinx Book Theme, so some functionality may not be present if you choose a custom theme. For example, the Launch Buttons are not supported in most Sphinx themes."

• [ ] Add Google Colab launch buttons for pages that have code

• [ ] Include "full screen", "GitHub", and "download md/pdf" launch buttons as in OG-Core documentation.

• [ ] Create a GitHub Pages site to host our documentation which GitHub automatically uploads any merged changes to the rendered documentation on the site. This is done through creating a GitHub Pages site for the repository (@rickecon has to do this) and setting up a GitHub Action to render and upload the documentation. The current GH Actions are in the ./github/workflow/ folder. There is currently just an action Test documentation builds that just builds the documentation and makes sure there isn't an error. Examples of GH Actions that build the documentation and upload it to a GitHub Page site are PolicyEngine-US/.../push.yaml "Deploy documentation" action and OG-Core/.../deploy_docs.yml action.

cc: @ss7886

[rickecon]

@rickecon will do this issue. Some of the steps we cannot do before launch. And @rickecon knows how to do all of the steps.