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 /docs/ folder and move all documentation there #107

Closed
jithinbp opened this issue Jun 10, 2017 · 1 comment
Closed

Create a /docs/ folder and move all documentation there #107

jithinbp opened this issue Jun 10, 2017 · 1 comment

Comments

@jithinbp
Copy link
Contributor

At present, experiment specific helpfiles are located in psl_res/HTML/ , and these will be moved to /docs/

Once the YayDoc generator has been setup correctly, setup.py must copy the docs folder to a known location, and the path must also be updated in PSL_Apps/bin/Experiments .

jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jun 10, 2017
 issue fossasia#107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jun 10, 2017
 issue fossasia#107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
mariobehling pushed a commit that referenced this issue Jun 10, 2017
…files (#106)

* Fixed sensorpendulum app in the Physics section

Made compatible with non-blocking calls defined in PSL.Peripherals.I2C .
Bug fixes in template file.
included saveData button to UI
Fixes #93

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

* edited Makefile. partly fixes #95

* fix DUST_SENSOR.py . Add screenshot & help file

 fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* remove pre-compiled layout templates

partly fixes #98

* change references to all precompiled layouts that do not match ui_*.py

fixes #98

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* edited Makefile. partly fixes #95

fix DUST_SENSOR.py . Add screenshot & help file

fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* FIX DUST_SENSOR.py (#97)

* Fixed sensorpendulum app in the Physics section

Made compatible with non-blocking calls defined in PSL.Peripherals.I2C .
Bug fixes in template file.
included saveData button to UI
Fixes #93

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

* edited Makefile. partly fixes #95

* fix DUST_SENSOR.py . Add screenshot & help file

 fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

Update README.md

Update README.md

* remove pre-compiled layout templates

partly fixes #98

* change references to all precompiled layouts that do not match ui_*.py

fixes #98

* travis.yml modified to compile template files

 fixes #95

* lay groundwork for calibrator using ADS1115 16-bit ADC

start work on #100

* add screenshots of experiment results

 working towards #102

* add more screenshots to documentation

part of #102

* changes based on Codacy recommendations

prid=641752

* more changes based on Codacy recommendations

prid=641752

* Update README.md

partly fixes #88
added contents from blog post 1

* Update README.md

Partly fixes #88
Add contents from blog post 2 : Communicating with PSLab

* added jekyll framework for experiment helpfiles in markdown format

 working towards #103

* fixed sip version mismatch error

fixes #101

* changes based on Codacy recommendations

* Update README.md

partly fixes #88
added contents from blog post 1

Update README.md

Partly fixes #88
Add contents from blog post 2 : Communicating with PSLab

* fixed sip version mismatch error

fixes #101

changes based on Codacy recommendations

 fix sip version mismatch error

fixes #101

* add dependency python-pyqtgraph for travis

 fixes #105

* configure travis to install pyqtgraph from source

 second atempt at #105 . python-pyqtgraph is not available from the debian repo of travis

* configure travis to install pyqtgraph from source

 forgot to remove apt-get line. bug fix for #105

* configure travis to use requirements.txt and install dependencies from pip

 another approach for #105

* configure travis to use requirements.txt and install dependencies from pip. Explicity call pip install -r requirements.txt

 another approach for #105

* configure travis to install pslab-python via git

 issue #105

* add setuptools in requirements.txt ; it is required for installing pslab-python dependency

 issue #105

* wrote a base_url include script for jekyll

 the static html created by Jekyll had broken relative links if not used with the Jekyll server. For resource efficiency, the generated html links should work regardless of the location. issue #103

* converting html to markdown format #103

converted A_AC_AND_DC.html
added 5 schematics made with KiCAD

Copied all the older html files to _apps, and renamed them to md
they now need to be edited and converted to markdown (Kramdown syntax)

* converting html to markdown format #103, adding screenshots: issue #103

 converted B_LEMON_CELL.html added 3 schematics made with KiCAD and a screenshot

* converting html to markdown format #103, adding screenshots: issue #103

 converted C_AC_GENERATOR.html added schematic made with KiCAD and a screenshot

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jun 10, 2017
 issue fossasia#107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jun 10, 2017
 issue fossasia#107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jun 10, 2017
 issue fossasia#107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jun 10, 2017
 issue fossasia#107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jun 10, 2017
 issue fossasia#107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files
jithinbp added a commit that referenced this issue Jun 17, 2017
added jekyll framework for experiment helpfiles in markdown format. issues #107   #103
Converted the following helpfiles to markdown
- Transistor CE, CB #116 
- Resistors #115 
- Diode IV #108 
- N-Channel FET characteristics #109 
- Dust sensor #117 

- Attempted to fix Travis build issue by using setup.py to install pslab-python repository. Did not work. Will be trying a different method (Explicitly copying files to the path ) in a separate PR made from a fresh branch.

* Fixed sensorpendulum app in the Physics section

Made compatible with non-blocking calls defined in PSL.Peripherals.I2C .
Bug fixes in template file.
included saveData button to UI
Fixes #93

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

* edited Makefile. partly fixes #95

* fix DUST_SENSOR.py . Add screenshot & help file

 fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* remove pre-compiled layout templates

partly fixes #98

* change references to all precompiled layouts that do not match ui_*.py

fixes #98

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* edited Makefile. partly fixes #95

fix DUST_SENSOR.py . Add screenshot & help file

fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* FIX DUST_SENSOR.py (#97)

* Fixed sensorpendulum app in the Physics section

Made compatible with non-blocking calls defined in PSL.Peripherals.I2C .
Bug fixes in template file.
included saveData button to UI
Fixes #93

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

* edited Makefile. partly fixes #95

* fix DUST_SENSOR.py . Add screenshot & help file

 fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

Update README.md

Update README.md

* remove pre-compiled layout templates

partly fixes #98

* change references to all precompiled layouts that do not match ui_*.py

fixes #98

* travis.yml modified to compile template files

 fixes #95

* lay groundwork for calibrator using ADS1115 16-bit ADC

start work on #100

* add screenshots of experiment results

 working towards #102

* add more screenshots to documentation

part of #102

* changes based on Codacy recommendations

prid=641752

* more changes based on Codacy recommendations

prid=641752

* Update README.md

partly fixes #88
added contents from blog post 1

* Update README.md

Partly fixes #88
Add contents from blog post 2 : Communicating with PSLab

* added jekyll framework for experiment helpfiles in markdown format

 working towards #103

* fixed sip version mismatch error

fixes #101

* changes based on Codacy recommendations

* Update README.md

partly fixes #88
added contents from blog post 1

Update README.md

Partly fixes #88
Add contents from blog post 2 : Communicating with PSLab

* fixed sip version mismatch error

fixes #101

changes based on Codacy recommendations

 fix sip version mismatch error

fixes #101

* add dependency python-pyqtgraph for travis

 fixes #105

* configure travis to install pyqtgraph from source

 second atempt at #105 . python-pyqtgraph is not available from the debian repo of travis

* configure travis to install pyqtgraph from source

 forgot to remove apt-get line. bug fix for #105

* configure travis to use requirements.txt and install dependencies from pip

 another approach for #105

* configure travis to use requirements.txt and install dependencies from pip. Explicity call pip install -r requirements.txt

 another approach for #105

* configure travis to install pslab-python via git

 issue #105

* add setuptools in requirements.txt ; it is required for installing pslab-python dependency

 issue #105

* wrote a base_url include script for jekyll

 the static html created by Jekyll had broken relative links if not used with the Jekyll server. For resource efficiency, the generated html links should work regardless of the location. issue #103

* converting html to markdown format #103

converted A_AC_AND_DC.html
added 5 schematics made with KiCAD

Copied all the older html files to _apps, and renamed them to md
they now need to be edited and converted to markdown (Kramdown syntax)

* converting html to markdown format #103, adding screenshots: issue #103

 converted B_LEMON_CELL.html added 3 schematics made with KiCAD and a screenshot

* converting html to markdown format #103, adding screenshots: issue #103

 converted C_AC_GENERATOR.html added schematic made with KiCAD and a screenshot

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* Add md documentation for diode_IV, schematic

 issue #108

* add md doc for N-channel JFET app, screenshot

 issue #109 . also added a screenshot for Diode IV . #102

* Update README.md

updated README.md

* Update README.md

*  Improved GUI menus for Sensor Data Logger

 -Functions without arguments are created as QMenuAction

* Update README.md

* GUI menus for Sensor Data Logger. Decimal,Numberic input

 -Functions with user defined variable inputs are defined as QSpinbox/QDoubleSpinBox

* Fixed sensorpendulum app in the Physics section

Made compatible with non-blocking calls defined in PSL.Peripherals.I2C .
Bug fixes in template file.
included saveData button to UI
Fixes #93

* code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

* Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

* edited Makefile. partly fixes #95

* fix DUST_SENSOR.py . Add screenshot & help file

 fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* Update README.md

* Update README.md

* remove pre-compiled layout templates

partly fixes #98

* change references to all precompiled layouts that do not match ui_*.py

fixes #98

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* edited Makefile. partly fixes #95

fix DUST_SENSOR.py . Add screenshot & help file

fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* travis.yml modified to compile template files

 fixes #95

* lay groundwork for calibrator using ADS1115 16-bit ADC

start work on #100

* add screenshots of experiment results

 working towards #102

* add more screenshots to documentation

part of #102

* changes based on Codacy recommendations

prid=641752

* more changes based on Codacy recommendations

prid=641752

* Update README.md

partly fixes #88
added contents from blog post 1

* Update README.md

Partly fixes #88
Add contents from blog post 2 : Communicating with PSLab

* added jekyll framework for experiment helpfiles in markdown format

 working towards #103

* fixed sip version mismatch error

fixes #101

* fixed sip version mismatch error

fixes #101

changes based on Codacy recommendations

 fix sip version mismatch error

fixes #101

* changes based on Codacy recommendations

* add dependency python-pyqtgraph for travis

 fixes #105

* configure travis to install pyqtgraph from source

 second atempt at #105 . python-pyqtgraph is not available from the debian repo of travis

* configure travis to install pyqtgraph from source

 forgot to remove apt-get line. bug fix for #105

* configure travis to use requirements.txt and install dependencies from pip

 another approach for #105

* configure travis to use requirements.txt and install dependencies from pip. Explicity call pip install -r requirements.txt

 another approach for #105

* configure travis to install pslab-python via git

 issue #105

* add setuptools in requirements.txt ; it is required for installing pslab-python dependency

 issue #105

* wrote a base_url include script for jekyll

 the static html created by Jekyll had broken relative links if not used with the Jekyll server. For resource efficiency, the generated html links should work regardless of the location. issue #103

* converting html to markdown format #103

converted A_AC_AND_DC.html
added 5 schematics made with KiCAD

Copied all the older html files to _apps, and renamed them to md
they now need to be edited and converted to markdown (Kramdown syntax)

* converting html to markdown format #103, adding screenshots: issue #103

 converted B_LEMON_CELL.html added 3 schematics made with KiCAD and a screenshot

* converting html to markdown format #103, adding screenshots: issue #103

 converted C_AC_GENERATOR.html added schematic made with KiCAD and a screenshot

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* Add md documentation for diode_IV, schematic

 issue #108

* add md doc for N-channel JFET app, screenshot

 issue #109 . also added a screenshot for Diode IV . #102

* Fixed sensorpendulum app in the Physics section

Made compatible with non-blocking calls defined in PSL.Peripherals.I2C .
Bug fixes in template file.
included saveData button to UI
Fixes #93

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* edited Makefile. partly fixes #95

* fix DUST_SENSOR.py . Add screenshot & help file

 fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* edited Makefile. partly fixes #95

fix DUST_SENSOR.py . Add screenshot & help file

fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* added jekyll framework for experiment helpfiles in markdown format

 working towards #103

* fixed sip version mismatch error

fixes #101

* configure travis to install pyqtgraph from source

 second atempt at #105 . python-pyqtgraph is not available from the debian repo of travis

* configure travis to use requirements.txt and install dependencies from pip

 another approach for #105

* configure travis to install pslab-python via git

 issue #105

* add setuptools in requirements.txt ; it is required for installing pslab-python dependency

 issue #105

* wrote a base_url include script for jekyll

 the static html created by Jekyll had broken relative links if not used with the Jekyll server. For resource efficiency, the generated html links should work regardless of the location. issue #103

* converting html to markdown format #103

converted A_AC_AND_DC.html
added 5 schematics made with KiCAD

Copied all the older html files to _apps, and renamed them to md
they now need to be edited and converted to markdown (Kramdown syntax)

* converting html to markdown format #103, adding screenshots: issue #103

 converted B_LEMON_CELL.html added 3 schematics made with KiCAD and a screenshot

* converting html to markdown format #103, adding screenshots: issue #103

 converted C_AC_GENERATOR.html added schematic made with KiCAD and a screenshot

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* Add md documentation for diode_IV, schematic

 issue #108

* add md doc for N-channel JFET app, screenshot

 issue #109 . also added a screenshot for Diode IV . #102

* Fixed sensorpendulum app in the Physics section

Made compatible with non-blocking calls defined in PSL.Peripherals.I2C .
Bug fixes in template file.
included saveData button to UI
Fixes #93

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* edited Makefile. partly fixes #95

* Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.

code quality edits based on Codacy feedback

changes to Y_sensorpendulum.py

Configure Travis to autocompile template files

 Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py

Configure Travis to autocompile template files

Changes to travis.yml , B_SpeedOfSound.py, J_rodpend.py, N_pendulum.py. partly fixes #95
Travis checks against Python versions 2.7,3.3,3.4 . 3.2 build is failing for an as yet unidentified reason, and has temporarily been disabled.
Fixes #95

* edited Makefile. partly fixes #95

fix DUST_SENSOR.py . Add screenshot & help file

fixes #96 . template changed to ui_dsm501a , indoors dust level screenshot added, help file included

* added jekyll framework for experiment helpfiles in markdown format

 working towards #103

* fixed sip version mismatch error

fixes #101

* configure travis to install pyqtgraph from source

 second atempt at #105 . python-pyqtgraph is not available from the debian repo of travis

* configure travis to use requirements.txt and install dependencies from pip

 another approach for #105

* configure travis to install pslab-python via git

 issue #105

* add setuptools in requirements.txt ; it is required for installing pslab-python dependency

 issue #105

* wrote a base_url include script for jekyll

 the static html created by Jekyll had broken relative links if not used with the Jekyll server. For resource efficiency, the generated html links should work regardless of the location. issue #103

* converting html to markdown format #103

converted A_AC_AND_DC.html
added 5 schematics made with KiCAD

Copied all the older html files to _apps, and renamed them to md
they now need to be edited and converted to markdown (Kramdown syntax)

* converting html to markdown format #103, adding screenshots: issue #103

 converted B_LEMON_CELL.html added 3 schematics made with KiCAD and a screenshot

* converting html to markdown format #103, adding screenshots: issue #103

 converted C_AC_GENERATOR.html added schematic made with KiCAD and a screenshot

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* created docs folder. moved files from psl_res/

 issue #107 . files in psl_res/HTML/ have been left untouched so that the app will continue to work for existing users and display the old-style help files

* Add md documentation for diode_IV, schematic

 issue #108

* add md doc for N-channel JFET app, screenshot

 issue #109 . also added a screenshot for Diode IV . #102

*  changed travis.yml to install pslab-python using setup.py

 issue #114

*  changed travis.yml to install pslab-python using setup.py

 issue #114 . syntax error correction

* added documentation for introduction to resistors app

fixes #115 . also added an include script for a resistors-in-parallel calculator

* add md doc for transistor-CE . issue #116

* add md doc for transistor-CE . issue #116. newline fix

* Added md docs and schematics for dust sensor app

fixes #117 . Also added screenshots for sensor pendulum to the _apps directory. #102
@mariobehling
Copy link
Member

Please integrate with Yaydoc and change all html files to MD files now.

jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jul 18, 2017
jithinbp added a commit to jithinbp/pslab-desktop-apps that referenced this issue Jul 18, 2017
mariobehling pushed a commit that referenced this issue Jun 1, 2018
* added .yaydoc.yml

 issue #107

* spelling error fix PSLAb to PSLab in yaydoc.yml

* change docurl to pslabdesktop.fossasia.org in yaydoc.yml

* change logo to images/logo.png in yaydoc.yml
issue #107
@cweitat cweitat closed this as completed May 13, 2019
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

3 participants