Browse Source

Setup updates

jbuisine 1 year ago
parent
commit
bc24c7549d

+ 1 - 1
.gitignore

@@ -54,4 +54,4 @@ coverage.xml
 
 # PyBuilder
 target/
-
+.python-version

+ 0 - 1
.python-version

@@ -1 +0,0 @@
-thesis-venv

+ 2 - 1
CONTRIBUTION.md

@@ -95,6 +95,8 @@ bash build.sh
 firefox docs/index.html
 ```
 
+Do not forget to generate new documentation output before doing a pull request.
+
 ## Test implementation
 
 This project use the [doctest](https://docs.python.org/3/library/doctest.html) package which enables to write tests into documentation as shown in example below:
@@ -138,7 +140,6 @@ python setup.py build
 This command do a lot of thing for you:
   - Runs the tests from documentation and raise errors if there are.
   - Formats all **\*.py** inside *ipfml* folder using **yapf**.
-  - Generate new documentation output inside **docs** folder.
 
 ## Pull request
 

BIN
docs/build/doctrees/contributing.doctree


BIN
docs/build/doctrees/description.doctree


BIN
docs/build/doctrees/environment.pickle


BIN
docs/build/doctrees/examples.doctree


BIN
docs/build/doctrees/index.doctree


BIN
docs/build/doctrees/ipfml.doctree


+ 1 - 1
docs/build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: cd05a23d4d55cff9b2a456d1f35fc945
+config: 1c8ed53caf85831b15e6fb8cd7f810e0
 tags: 645f666f9bcd5a90fca523b33c5a78b7

+ 1 - 1
docs/build/html/_static/documentation_options.js

@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
     URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
-    VERSION: 'v0.2.4',
+    VERSION: 'v0.2.5',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
     FILE_SUFFIX: '.html',

+ 2 - 2
docs/build/html/contributing.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Contributing &mdash; IPFML v0.2.4 documentation</title>
+  <title>Contributing &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 2 - 2
docs/build/html/description.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Description &mdash; IPFML v0.2.4 documentation</title>
+  <title>Description &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 2 - 2
docs/build/html/examples.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Examples &mdash; IPFML v0.2.4 documentation</title>
+  <title>Examples &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 2 - 2
docs/build/html/genindex.html

@@ -9,7 +9,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Index &mdash; IPFML v0.2.4 documentation</title>
+  <title>Index &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 2 - 2
docs/build/html/index.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Image Processing For Machine Learning &mdash; IPFML v0.2.4 documentation</title>
+  <title>Image Processing For Machine Learning &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -57,7 +57,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 2 - 2
docs/build/html/ipfml.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Documentation &mdash; IPFML v0.2.4 documentation</title>
+  <title>Documentation &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -58,7 +58,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 1 - 1
docs/build/html/objects.inv

@@ -1,6 +1,6 @@
 # Sphinx inventory version 2
 # Project: IPFML
-# Version: 0.2.4
+# Version: 0.2.5
 # The remainder of this file is compressed using zlib.
 xÚ¥”MkÜ0†ïþ‚öº¦é1·4ÛBa�Ð%ÉEÈò¬<T_Hr7ί¯m­c‡f©¥½Ù£÷y5’fíAÉò€2€ó¥6è�ØîZ™º•@¾×› ä§Û|&›ÿ¥JÎZÞtôÍâÐjÐhrµ49GÖz�Lçò’YÉ8dãFô¨SLæ:¨6Ðcƒ!;Ïd ¬—k‘¸¿‚à�ûÕï}Ò—ÝÝ|KØbBè.b9P•
 =ì·ý•ís Ÿ

+ 2 - 2
docs/build/html/py-modindex.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Python Module Index &mdash; IPFML v0.2.4 documentation</title>
+  <title>Python Module Index &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -59,7 +59,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 2 - 2
docs/build/html/search.html

@@ -8,7 +8,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Search &mdash; IPFML v0.2.4 documentation</title>
+  <title>Search &mdash; IPFML v0.2.5 documentation</title>
   
 
   
@@ -56,7 +56,7 @@
             
             
               <div class="version">
-                0.2.4
+                0.2.5
               </div>
             
           

+ 2 - 2
docs/source/conf.py

@@ -24,9 +24,9 @@ copyright = '2019, Jérôme BUISINE'
 author = 'Jérôme BUISINE'
 
 # The short X.Y version
-version = '0.2.4'
+version = '0.2.5'
 # The full versiabson, including alpha/beta/rc tags
-release = 'v0.2.4'
+release = 'v0.2.5'
 
 
 # -- General configuration ---------------------------------------------------

+ 1 - 1
requirements.txt

@@ -1,4 +1,3 @@
-sphinx
 matplotlib
 numpy
 Pillow
@@ -9,3 +8,4 @@ opencv-python
 scipy
 yapf
 doctest
+sphinx

+ 2 - 10
setup.py

@@ -28,22 +28,14 @@ class BuildTestCommand(setuptools.command.build_py.build_py):
             print("Runs format code command...")
             self.spawn(['yapf', '-ir', '-vv', 'ipfml'])
         except RuntimeError:
-            self.warn('format pakcage code failed')
-
-        # Run update auto generated documentation
-        try:
-            print("==============================")
-            print("Runs update of auto generated documentation...")
-            self.spawn(['bash', './build.sh'])
-        except RuntimeError:
-            self.warn('Error during documentation rendering')
+            self.warn('Format pakcage code failed')
 
         setuptools.command.build_py.build_py.run(self)
 
 
 setup(
     name='ipfml',
-    version='0.2.4',
+    version='0.2.5',
     description='Image Processing For Machine Learning',
     long_description=readme(),
     classifiers=[