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

Create a single conversion script for generating html #138

Closed
12 tasks done
ehmatthes opened this issue May 23, 2017 · 1 comment
Closed
12 tasks done

Create a single conversion script for generating html #138

ehmatthes opened this issue May 23, 2017 · 1 comment

Comments

@ehmatthes
Copy link
Owner

ehmatthes commented May 23, 2017

The original project had a series of shell and python scripts to generate html files from the notebooks. Some of that was really hacky, because I didn't know how Jupyter/ IPython notebooks were generated in enough detail. In this issue, I'll pull this into one Python script, that uses nbconvert and templates as much as possible. All remaining conversion work will be done in Python.

  • Create base Python conversion script.
  • Base conversion script in root project folder. /notebooks folder should only contain notebooks. Other resources should be in folders under project root.

Incorporate the functionality of all the individual .sh and .py files in scripts/ into build_html_site.py, and templates. When all of this functionality has been updated and simplified, these scripts can be deleted.

  • build_html_pages.sh
    • calls all of the other scripts, this should be checked off last
  • sed section of build_html_pages.sh to make output display initially on Mapping Global Earthquake Activity
    • Add a tag that allows specific code cells to show output by default?
    • Add a tag that allows specific notebooks to show all output initially by default?
  • (keeping this) build_all_exercises_page.py
    • May just keep this as a separate issue for completion.
  • create_common_hmtl.sh
    • The default nbconvert behavior is to link to other notebooks on nbviewer. This script modifies the html output to link to other html notebooks. (Make sure links between notebooks work.)
  • highlight_code.py
    • highlight specified lines of code
  • highlight_inline_code.sh
    • highlight code snippets in bodies of text
  • show_hide_output.py
  • convert_home_links.py
    • This script converts links from "index.html" to "/". The server responds by serving the index page. Difference between requesting introtopython.org/index.html and introtopython.org.
  • remove_input_references.py
  • build_index.py
    • look at actual code before checking this off
@ehmatthes
Copy link
Owner Author

This is a great issue to finally close!

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

No branches or pull requests

1 participant