Added qutip-qip tutorials to documentation on Read the docs

[rum1887]

Closes: Add qutip-qip tutorials to documentation on Read the docs #204
Did not add the examples in a gallery form like in Mitiq. can be converted to that form easily tho

Just added the links to the text

[rum1887]

This is the cropped .html file generated from qutip/tutorials
pr: qutip/qutip-tutorials#64
file: qutip-qip.html
have to render this in the qutip-qip tutorials section now

[rum1887]

hi , I have generated the html from qutip tutorials
qutip/qutip-tutorials#64

Planning on creating a python script to render the html to tutorials.rst

[rum1887]

hi, I have generated the HTML from qutip tutorials
qutip/qutip-tutorials#64

Planning on creating a Python script to render the HTML to tutorials.rst

I have created a file called html2rst.py which renders the HTML into .rst

This is the html2rst.py file

import subprocess

def convert_html_to_rst(html_file_path, rst_file_path):
   # Use the subprocess module to call the pandoc command-line tool
    subprocess.run(['pandoc', html_file_path, '-o', rst_file_path])

html_file_path = 'qutip-qip.html'
rst_file_path = 'tutorials.rst'
convert_html_to_rst(html_file_path, rst_file_path)

I'll have to provide the link to the html file generated previously from the qutip-qip tutorials. qutip/qutip-tutorials#64 file qutip-qip.html

I can locally generate the .html by running the script create_qutip-qip.py that I created by modifying the create_index.py.

But unless I run the create_qutip-qip.py , the HTML is not generated, I need a deployed HTML link from GitHub.

Even the index.html for the index file is not available on GitHub, I can create it locally by running the create_index.py script

@nathanshammah @BoxiLi any insights on how to add an HTML link that can be accessed?

Hope I communicated it clearly

This is the cropped local version of the tutorials doc after rendering the HTML(need to remove the header, footer and title):

[rum1887]

hi , I have generated the html from qutip tutorials
qutip/qutip-tutorials#64

Planning on creating a python script to render the html to tutorials.rst

I have created a file called html2rst.py which renders the html into .rst

This is the html2rst.py file

import subprocess

def convert_html_to_rst(html_file_path, rst_file_path):
   # Use the subprocess module to call the pandoc command-line tool
    subprocess.run(['pandoc', html_file_path, '-o', rst_file_path])

html_file_path = 'qutip-qip.html'
rst_file_path = 'tutorials.rst'
convert_html_to_rst(html_file_path, rst_file_path)

This is the cropped local version of the tutorials doc after rendering the html(need to remove the header , footer and title):

I'll have to provide the link to the html file generated previously for the qutip-qip tutorials. qutip/qutip-tutorials#64 file qutip-qip.html

I can locally generate the .html by running the script create_qutip-qip.py that I created by modifying the create_index.py.

even the index.html for the index file is not available on the GitHub, when I run the create_index.py, I can locally generate the index.html

hope I communicated it well

@nathanshammah @BoxiLi how to add the HTML link, I can't find the index.html too on GitHub and I can't add a local link

TLDR:

• Have created the cropped version of HTML using the jinja template (html file is created when the script is run)
• Created Python script to render the HTML into the tutorial.rst (need the deployed .html so I can use the link)

Issue: Need to get the link

[BoxiLi]

What you described sounds almost like a success.

I don't think we should push any code to qutip-tutorial. The files should be in qutip-qip.

The question is, do you really need the deployed HTML? If you can create it locally, you should be able to crop it from the file locally, or did I miss something?

I'm thinking more of something like this: The Python script is executed automatically when calling make html, which reads the source file from qutip-tutorial, generates the HTML locally, and then crops it to get the rst file. Do you think it is feasible?

[rum1887]

What you described sounds almost like a success.

I don't think we should push any code to qutip-tutorial. The files should be in qutip-qip.

The question is, do you really need the deployed HTML? If you can create it locally, you should be able to crop it from the file locally, or did I miss something?

I'm thinking more of something like this: The Python script is executed automatically when calling make html, which reads the source file from qutip-tutorial, generates the HTML locally, and then crops it to get the rst file. Do you think it is feasible?

Feasible, doing it rn!

[rum1887]

will close this pr!
new pr reopened at #207