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

make readthedocs documentation awesome #55

Closed
10 of 12 tasks
drbenvincent opened this issue Nov 15, 2022 · 2 comments
Closed
10 of 12 tasks

make readthedocs documentation awesome #55

drbenvincent opened this issue Nov 15, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@drbenvincent
Copy link
Collaborator

drbenvincent commented Nov 15, 2022

#53 added sphinx documentation and got it working reliably on readthedocs. This issue focuses on improving the docs and making them look nicer!

Focussing mostly on the index page:

  • Better page title
  • Double check best location for images (and other static resources) for the docs
  • Add logo when CausalPy logo #27 is complete
  • Add some more compelling content, taking inspiration from the GitHub README. This should include images.
    • Since the move to separate notebook examples, we not longer have auto image export. So it would be good to create a script to generate images for the documentation.
  • Add a quickstart
  • Rather than itemise individual examples in the sidebar, switch to having one page of example. So there will be one Examples entry in the sidebar which leads to a single page which will expand with examples over time. Also see SC: in-depth notebook #35, ITS: in-depth notebook #36, DiD: in-depth notebook #37, RDD: in-depth notebook #38, and Add examples for 'classic' causal inference datasets #44.
    • Fix any links to old notebooks in the README
  • Remove module index and search page
  • Add info relating to PyMC Labs supporting the package
  • opt out of remote execution of notebooks on readthedocs
  • Can we improve/simplify the importing of data with pathlib. Current method looks clumsy
@drbenvincent
Copy link
Collaborator Author

After a lot of faffing about with remote build of readthedocs, we have the new structure (with separated small notebooks) up and running https://causalpy.readthedocs.io

@drbenvincent
Copy link
Collaborator Author

Closing this. Only substantive remaining issue is the logo, but that's dealt with in #27

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant