Skip to content

Latest commit

 

History

History
230 lines (149 loc) · 5.33 KB

info.rst

File metadata and controls

230 lines (149 loc) · 5.33 KB
Raw

gh-pages

TODO: do it with: circleci

Publishing sphinx-generated docs on github:

https://daler.github.io/sphinxdoc-test/includeme.html

Upload to github

"$WD/build/html" contains the pystsamsl website. Now we start to upload to github server. Clone from github to a temporary directory, and checkout gh-pages branch

First time ` WD=~/git/pystatsml cd ~/git mv pystatsml_gh-pages pystatsml_gh-pages.bak git clone git@github.com:duchesnay/pystatsml.git pystatsml_gh-pages cd pystatsml_gh-pages git symbolic-ref HEAD refs/heads/gh-pages rm .git/index git clean -fdx cp -r $WD/build/html/* ./ cp -r $WD/auto_gallery ./ git add . git add -f auto_gallery git add -f _sources git add -f _static git add -f _images touch .nojekyll gedit index.html # see blow git commit -am "gh-pages First commit" git push origin gh-pages firefox index.html `

Update ` WD=~/git/pystatsml cd $WD make pdf html singlehtml cd ~/git/pystatsml_gh-pages git checkout gh-pages rsync -avu $WD/build/html/* ./ rsync -avu $WD/auto_gallery ./ git add . git add -f auto_gallery git add -f _sources git add -f _static git add -f _images meld index.html index.html.save #gedit # see blow git commit -am "gh-pages update commit" git push origin gh-pages firefox index.html `

Then ``` gedit index.html

Replace: ```

<section id="phantom">

<h1>Phantom<a class="headerlink" href="#phantom" title="Permalink to this headline">¶</a></h1> </section> ``` by

```
<section id="pystatml">

<h1>Statistics and Machine Learning in Python<a class="headerlink" href="#pystatml" title="Permalink to this headline">¶</a></h1> </section>

<hr>

<p><a href="https://duchesnay.github.io/">Edouard Duchesnay</a>, <a href="https://www.umu.se/en/staff/toklot02/">Tommy Löfstedt</a>, Feki Younes</p> ```

Then

` git commit -am "Title and authors" git push origin gh-pages firefox $WD/build/html/index.html `

Now, you can visit your updated website at https://duchesnay.github.io/pystatsml.

ML Resources

Jupyter Notebooks

https://jupyterbook.org/advanced/advanced.html#jupyter-cell-tags

Markdown

http://daringfireball.net/projects/markdown/basics

R with Jupyther

conda install -c r r-essentials

Sphinx

http://sphinx-doc.org/

IPython notebooks + Sphinx

http://sphinx-ipynb.readthedocs.org/en/latest/howto.html

nbsphinx: Jupyter Notebook Tools for Sphinx

https://nbsphinx.readthedocs.io/en/0.3.3/

nbsphinx is a Sphinx extension that provides a source parser for *.ipynb files. Custom Sphinx directives are used to show Jupyter Notebook code cells (and of course their results) in both HTML and LaTeX output. Un-evaluated notebooks – i.e. notebooks without stored output cells – will be automatically executed during the Sphinx build process.

conda install -c conda-forge nbsphinx

sphinx-gallery

https://sphinx-gallery.readthedocs.io/en/latest/

pip install sphinx-gallery

http://www.scipy-lectures.org

https://github.com/scipy-lectures/scipy-lecture-notes

strip jupyter output before submission

https://github.com/kynan/nbstripout

conda install -c conda-forge nbstripout

Set up the git filter and attributes as described in the manual installation instructions below:

cd pystatsml nbstripout --install

rst

http://docutils.sourceforge.net/rst.html http://docutils.sourceforge.net/docs/ref/rst/

R vs Python

https://www.datacamp.com/community/tutorials/r-or-python-for-data-analysis http://pandas.pydata.org/pandas-docs/stable/comparison_with_r.html

Mail to share the course

Please find the link to my Machine Learning course in Python, it is a draft version: ftp://ftp.cea.fr//pub/unati/people/educhesnay/pystatml/StatisticsMachineLearningPython.pdf

Below the link to github: https://github.com/duchesnay/pystatsml

git clone https://github.com/duchesnay/pystatsml.git

Basically, it uses Jupyter notebook and pure python, everything is converted to rst and assembled to html or pdf using sphynx.

It is a draft version, not finished yet with many spelling mistakes.

Please fork and perform some pull request. If you are willing to contribute.