Skip to content

Commit

Permalink
fixes manything in the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sdpython committed Jan 14, 2018
1 parent 051e3fc commit ef53506
Show file tree
Hide file tree
Showing 10 changed files with 21 additions and 9 deletions.
4 changes: 2 additions & 2 deletions _doc/sphinxdoc/source/api/algorithm.rst
Expand Up @@ -8,6 +8,6 @@ Algorithmes
Optimisation Optimisation
++++++++++++ ++++++++++++


.. autosignature:: code_beatrix.algo.tsp.voyageur_commerce_simple .. autosignature:: code_beatrix.algorithm.tsp.voyageur_commerce_simple


.. autosignature:: code_beatrix.algo.tsp.plot_circuit .. autosignature:: code_beatrix.algorithm.tsp.plot_circuit
2 changes: 1 addition & 1 deletion _doc/sphinxdoc/source/api/notebooks.rst
Expand Up @@ -8,7 +8,7 @@ Notebooks
Javascript Javascript
++++++++++ ++++++++++


.. autosignature:: code_beatrix.ipython_helper.nbcanvas.display_canvas_point .. autosignature:: code_beatrix.ipythonhelper.nbcanvas.display_canvas_point


Snap, Scratch Snap, Scratch
+++++++++++++ +++++++++++++
Expand Down
2 changes: 1 addition & 1 deletion _doc/sphinxdoc/source/art/index_art.rst
Expand Up @@ -33,7 +33,7 @@ Indices et solutions


montage_video_correction montage_video_correction


.. _l-biblio_prog: .. _l-biblio_art:


Bibliographie Bibliographie
------------- -------------
Expand Down
2 changes: 1 addition & 1 deletion _doc/sphinxdoc/source/conf.py
Expand Up @@ -72,7 +72,7 @@
latex_elements['preamble'] += custom_preamble latex_elements['preamble'] += custom_preamble
mathdef_link_only = True mathdef_link_only = True


epkg_dictionary['AutioClip'] = 'https://zulko.github.io/moviepy/ref/AudioClip/AudioClip.html' epkg_dictionary['AudioClip'] = 'https://zulko.github.io/moviepy/ref/AudioClip/AudioClip.html'
epkg_dictionary['deep learning'] = 'https://en.wikipedia.org/wiki/Deep_learning' epkg_dictionary['deep learning'] = 'https://en.wikipedia.org/wiki/Deep_learning'
epkg_dictionary['fcn'] = 'https://github.com/wkentaro/fcn' epkg_dictionary['fcn'] = 'https://github.com/wkentaro/fcn'
epkg_dictionary['gif'] = 'https://fr.wikipedia.org/wiki/Graphics_Interchange_Format' epkg_dictionary['gif'] = 'https://fr.wikipedia.org/wiki/Graphics_Interchange_Format'
Expand Down
2 changes: 1 addition & 1 deletion _doc/sphinxdoc/source/index.rst
Expand Up @@ -46,7 +46,7 @@ Contenu rangé par thèmes
histoires/index_histoires histoires/index_histoires
maths/index_maths maths/index_maths
art/index_art art/index_art
API/index api/index
python_setup python_setup


On programme pour faire des jeux, des sites internets, des recherches scientifiques, On programme pour faire des jeux, des sites internets, des recherches scientifiques,
Expand Down
2 changes: 1 addition & 1 deletion _doc/sphinxdoc/source/maths/index_maths.rst
Expand Up @@ -50,7 +50,7 @@ Indices et solutions
compter_reel_correction compter_reel_correction
fractales_correction fractales_correction


.. _l-biblio_prog: .. _l-biblio_maths:


Bibliographie Bibliographie
------------- -------------
Expand Down
1 change: 1 addition & 0 deletions _doc/sphinxdoc/source/sessions/session_2016_10_18.rst
Expand Up @@ -40,6 +40,7 @@ Livres, Bibliographie


**Autres pistes** **Autres pistes**


* :ref:`l-biblio_art` à propos des médias
* :ref:`l-biblio_algo` à propos des algorithmes * :ref:`l-biblio_algo` à propos des algorithmes
* :ref:`l-biblio_prog` à propos de la programmation * :ref:`l-biblio_prog` à propos de la programmation
* :ref:`l-biblio_donnes` à propos des données * :ref:`l-biblio_donnes` à propos des données
6 changes: 6 additions & 0 deletions _doc/sphinxdoc/source/sessions/session_2018_01_13.rst
Expand Up @@ -69,3 +69,9 @@ de labyrinthe et ils s'y sont donnés à coeur joie.
Une heure était assurément trop court pour appréhender Une heure était assurément trop court pour appréhender
les outils mais quelques-uns ont su adapter un montage les outils mais quelques-uns ont su adapter un montage
donné comme premier exemple. donné comme premier exemple.

Livres, Bibliographie
---------------------

* :ref:`l-biblio_algo` à propos des algorithmes
* :ref:`l-biblio_art` à propos des médias
1 change: 1 addition & 0 deletions src/code_beatrix/algorithm/classroom.py
Expand Up @@ -172,6 +172,7 @@ def optimize_positions(positions, edges, max_iter=100, fLOG=noLOG,
@param positions dictionary ``{ name : (x, y) }`` @param positions dictionary ``{ name : (x, y) }``
@param edges list of affinities ``(name1, name2)`` @param edges list of affinities ``(name1, name2)``
@param max_iter maximum number of iterations @param max_iter maximum number of iterations
@param plot_folder if not None, saves images into this folder
@return positions, iterations @return positions, iterations
""" """
edges_dict = {} edges_dict = {}
Expand Down
8 changes: 6 additions & 2 deletions src/code_beatrix/faq/faq_video.py
Expand Up @@ -137,6 +137,7 @@ def audio_save(audio_or_file, filename, verbose=False, **kwargs):
Uses `write_audiofile <https://zulko.github.io/moviepy/ref/AudioClip.html?highlight=audioclip#moviepy.audio.AudioClip.AudioClip.write_audiofile>`_. Uses `write_audiofile <https://zulko.github.io/moviepy/ref/AudioClip.html?highlight=audioclip#moviepy.audio.AudioClip.AudioClip.write_audiofile>`_.
@param audio_or_file string or :epkg:`AudioClip` @param audio_or_file string or :epkg:`AudioClip`
@param filename save into this filename
@param verbose logging or not @param verbose logging or not
@param kwargs see `write_audiofile <https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html?highlight=videofileclip#moviepy.video.io.VideoFileClip.VideoFileClip.write_videofile>`_ @param kwargs see `write_audiofile <https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html?highlight=videofileclip#moviepy.video.io.VideoFileClip.VideoFileClip.write_videofile>`_
""" """
Expand Down Expand Up @@ -274,6 +275,7 @@ def video_save(video_or_file, filename, verbose=False, duration=None, **kwargs):
Uses `write_videofile <https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html?highlight=videofileclip#moviepy.video.io.VideoFileClip.VideoFileClip.write_videofile>`_. Uses `write_videofile <https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html?highlight=videofileclip#moviepy.video.io.VideoFileClip.VideoFileClip.write_videofile>`_.
@param video_or_file string or :epkg:`VideoClip` @param video_or_file string or :epkg:`VideoClip`
@param filename video saved into this filename
@param duration overwrite duration, @param duration overwrite duration,
see method `set_duration <https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html?highlight=videoclip#moviepy.video.VideoClip.VideoClip.set_duration>`_ see method `set_duration <https://zulko.github.io/moviepy/ref/VideoClip/VideoClip.html?highlight=videoclip#moviepy.video.VideoClip.VideoClip.set_duration>`_
@param verbose logging or not @param verbose logging or not
Expand Down Expand Up @@ -360,11 +362,13 @@ def video_replace_audio(video_or_file, new_sound, **kwargs):
@param video_or_file string or :epkg:`VideoClip` @param video_or_file string or :epkg:`VideoClip`
@param new_sound sound @param new_sound sound
@param kwargs see @see fn audio_modification @param kwargs see @see fn audio_modification
@param loop if True, *loop_duration* becomes the duration of the video
@return :epkg:`VideoClip` @return :epkg:`VideoClip`
The list of available transformations is at: The list of available transformations is at:
`vfx <https://zulko.github.io/moviepy/ref/videofx.html?highlight=vfx>`_. `vfx <https://zulko.github.io/moviepy/ref/videofx.html?highlight=vfx>`_.
If parameter ``loop=True`` is specified,
*loop_duration* becomes the duration of the video.
Example: Example:
Expand Down Expand Up @@ -706,7 +710,7 @@ def video_text(text, font=None, fontsize=32, size=None,
@param size image size, None to get the smallest one which @param size image size, None to get the smallest one which
contains the text, a float to get *size* times contains the text, a float to get *size* times
this smallest size this smallest size
@param backgorund background of the image @param background background of the image
@param opacity to overwrite the opacity, @param opacity to overwrite the opacity,
*color* and *background* should be 4-uple colors, *color* and *background* should be 4-uple colors,
the last number in ``(0, 0, 0, 255)`` represents the the last number in ``(0, 0, 0, 255)`` represents the
Expand Down

0 comments on commit ef53506

Please sign in to comment.