From fd4641f2671ffa6d28ab031485547c42bb134637 Mon Sep 17 00:00:00 2001 From: kpetersn Date: Wed, 1 Aug 2018 13:23:40 -0500 Subject: [PATCH 1/3] Renamed documentation directory so that it can be used with github pages. --- {documentation => docs}/Doxyfile | 0 {documentation => docs}/EnsemblePSOFly.txt | 0 {documentation => docs}/Makefile | 0 {documentation => docs}/Problems.html | 0 {documentation => docs}/README.md | 0 {documentation => docs}/epics_logo.gif | Bin {documentation => docs}/motor.html | 0 {documentation => docs}/motorDeviceDriver.html | 0 {documentation => docs}/motorRecord.html | 0 {documentation => docs}/motor_files.html | 0 {documentation => docs}/motor_notes.txt | 0 {documentation => docs}/motor_release.html | 0 .../presentations/MotorRec2015.pptx | Bin {documentation => docs}/trajectoryScan.html | 0 .../trajectoryScan_files/IDL_trajectory_actual.png | Bin .../trajectoryScan_files/IDL_trajectory_errors.png | Bin .../trajectoryScan_files/trajectoryPlot1.png | Bin .../trajectoryScan_files/trajectoryPlot2.png | Bin .../trajectoryScan_files/trajectoryScan.png | Bin .../trajectoryScan_files/trajectoryScanDebug.png | Bin 20 files changed, 0 insertions(+), 0 deletions(-) rename {documentation => docs}/Doxyfile (100%) rename {documentation => docs}/EnsemblePSOFly.txt (100%) rename {documentation => docs}/Makefile (100%) rename {documentation => docs}/Problems.html (100%) rename {documentation => docs}/README.md (100%) rename {documentation => docs}/epics_logo.gif (100%) rename {documentation => docs}/motor.html (100%) rename {documentation => docs}/motorDeviceDriver.html (100%) rename {documentation => docs}/motorRecord.html (100%) rename {documentation => docs}/motor_files.html (100%) rename {documentation => docs}/motor_notes.txt (100%) rename {documentation => docs}/motor_release.html (100%) rename {documentation => docs}/presentations/MotorRec2015.pptx (100%) rename {documentation => docs}/trajectoryScan.html (100%) rename {documentation => docs}/trajectoryScan_files/IDL_trajectory_actual.png (100%) rename {documentation => docs}/trajectoryScan_files/IDL_trajectory_errors.png (100%) rename {documentation => docs}/trajectoryScan_files/trajectoryPlot1.png (100%) rename {documentation => docs}/trajectoryScan_files/trajectoryPlot2.png (100%) rename {documentation => docs}/trajectoryScan_files/trajectoryScan.png (100%) rename {documentation => docs}/trajectoryScan_files/trajectoryScanDebug.png (100%) diff --git a/documentation/Doxyfile b/docs/Doxyfile similarity index 100% rename from documentation/Doxyfile rename to docs/Doxyfile diff --git a/documentation/EnsemblePSOFly.txt b/docs/EnsemblePSOFly.txt similarity index 100% rename from documentation/EnsemblePSOFly.txt rename to docs/EnsemblePSOFly.txt diff --git a/documentation/Makefile b/docs/Makefile similarity index 100% rename from documentation/Makefile rename to docs/Makefile diff --git a/documentation/Problems.html b/docs/Problems.html similarity index 100% rename from documentation/Problems.html rename to docs/Problems.html diff --git a/documentation/README.md b/docs/README.md similarity index 100% rename from documentation/README.md rename to docs/README.md diff --git a/documentation/epics_logo.gif b/docs/epics_logo.gif similarity index 100% rename from documentation/epics_logo.gif rename to docs/epics_logo.gif diff --git a/documentation/motor.html b/docs/motor.html similarity index 100% rename from documentation/motor.html rename to docs/motor.html diff --git a/documentation/motorDeviceDriver.html b/docs/motorDeviceDriver.html similarity index 100% rename from documentation/motorDeviceDriver.html rename to docs/motorDeviceDriver.html diff --git a/documentation/motorRecord.html b/docs/motorRecord.html similarity index 100% rename from documentation/motorRecord.html rename to docs/motorRecord.html diff --git a/documentation/motor_files.html b/docs/motor_files.html similarity index 100% rename from documentation/motor_files.html rename to docs/motor_files.html diff --git a/documentation/motor_notes.txt b/docs/motor_notes.txt similarity index 100% rename from documentation/motor_notes.txt rename to docs/motor_notes.txt diff --git a/documentation/motor_release.html b/docs/motor_release.html similarity index 100% rename from documentation/motor_release.html rename to docs/motor_release.html diff --git a/documentation/presentations/MotorRec2015.pptx b/docs/presentations/MotorRec2015.pptx similarity index 100% rename from documentation/presentations/MotorRec2015.pptx rename to docs/presentations/MotorRec2015.pptx diff --git a/documentation/trajectoryScan.html b/docs/trajectoryScan.html similarity index 100% rename from documentation/trajectoryScan.html rename to docs/trajectoryScan.html diff --git a/documentation/trajectoryScan_files/IDL_trajectory_actual.png b/docs/trajectoryScan_files/IDL_trajectory_actual.png similarity index 100% rename from documentation/trajectoryScan_files/IDL_trajectory_actual.png rename to docs/trajectoryScan_files/IDL_trajectory_actual.png diff --git a/documentation/trajectoryScan_files/IDL_trajectory_errors.png b/docs/trajectoryScan_files/IDL_trajectory_errors.png similarity index 100% rename from documentation/trajectoryScan_files/IDL_trajectory_errors.png rename to docs/trajectoryScan_files/IDL_trajectory_errors.png diff --git a/documentation/trajectoryScan_files/trajectoryPlot1.png b/docs/trajectoryScan_files/trajectoryPlot1.png similarity index 100% rename from documentation/trajectoryScan_files/trajectoryPlot1.png rename to docs/trajectoryScan_files/trajectoryPlot1.png diff --git a/documentation/trajectoryScan_files/trajectoryPlot2.png b/docs/trajectoryScan_files/trajectoryPlot2.png similarity index 100% rename from documentation/trajectoryScan_files/trajectoryPlot2.png rename to docs/trajectoryScan_files/trajectoryPlot2.png diff --git a/documentation/trajectoryScan_files/trajectoryScan.png b/docs/trajectoryScan_files/trajectoryScan.png similarity index 100% rename from documentation/trajectoryScan_files/trajectoryScan.png rename to docs/trajectoryScan_files/trajectoryScan.png diff --git a/documentation/trajectoryScan_files/trajectoryScanDebug.png b/docs/trajectoryScan_files/trajectoryScanDebug.png similarity index 100% rename from documentation/trajectoryScan_files/trajectoryScanDebug.png rename to docs/trajectoryScan_files/trajectoryScanDebug.png From 3b75e3096f0fc1a090769c03d7273b3cf2c4f42b Mon Sep 17 00:00:00 2001 From: kpetersn Date: Wed, 1 Aug 2018 13:26:17 -0500 Subject: [PATCH 2/3] Renamed motor.html to index.html so that it can be used with github pages. --- docs/{motor.html => index.html} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/{motor.html => index.html} (100%) diff --git a/docs/motor.html b/docs/index.html similarity index 100% rename from docs/motor.html rename to docs/index.html From d739f5c1dd53f10af2cdacb5ea2b6cbe4e3f24b8 Mon Sep 17 00:00:00 2001 From: kpetersn Date: Wed, 1 Aug 2018 13:37:13 -0500 Subject: [PATCH 3/3] Use github pages links instead of htmlpreview links --- README.md | 3 +-- docs/README.md | 12 ++++++------ docs/index.html | 9 +++++++++ 3 files changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 94a11455..cc86002f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ APS BCDA synApps module: motor **Note**: Current discussion on future of the *motor* module repository: https://github.com/epics-modules/motor/issues/55 For more information, see: -* [main page](http://htmlpreview.github.io/?https://github.com/epics-modules/motor/blob/master/documentation/motor.html) +* [main page](https://epics-modules.github.io/motor) * [motor wiki](https://github.com/epics-modules/motor/wiki) * http://www.aps.anl.gov/bcda/synApps * [HTML documentation](https://github.com/epics-modules/motor/blob/master/documentation/README.md) @@ -14,5 +14,4 @@ For more information, see: [Report an issue with Motor](https://github.com/epics-modules/motor/issues/new?title=%20ISSUE%20NAME%20HERE&body=**Describe%20the%20issue**%0A%0A**Steps%20to%20reproduce**%0A1.%20Step%20one%0A2.%20Step%20two%0A3.%20Step%20three%0A%0A**Expected%20behaivour**%0A%0A**Actual%20behaviour**%0A%0A**Build%20Environment**%0AArchitecture:%0AEpics%20Base%20Version:%0ADependent%20Module%20Versions:&labels=bug) [Request a feature](https://github.com/epics-modules/motor/issues/new?title=%20FEATURE%20SHORT%20DESCRIPTION&body=**Feature%20Long%20Description**%0A%0A**Why%20should%20this%20be%20added?**%0A&labels=enhancement) - converted from APS SVN repository: Fri Oct 16 12:31:41 CDT 2015 diff --git a/docs/README.md b/docs/README.md index 9a4b7e91..12d11f90 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,8 +1,8 @@ # HTML documentation -* [motor.html](http://htmlpreview.github.com/?https://github.com/epics-modules/motor/blob/master/documentation/motor.html) -* [motorDeviceDriver.html](http://htmlpreview.github.com/?https://github.com/epics-modules/motor/blob/master/documentation/motorDeviceDriver.html) -* [motorRecord.html](http://htmlpreview.github.com/?https://github.com/epics-modules/motor/blob/master/documentation/motorRecord.html) -* [motor_files.html](http://htmlpreview.github.com/?https://github.com/epics-modules/motor/blob/master/documentation/motor_files.html) -* [motor_release.html](http://htmlpreview.github.com/?https://github.com/epics-modules/motor/blob/master/documentation/motor_release.html) -* [trajectoryScan.html](http://htmlpreview.github.com/?https://github.com/epics-modules/motor/blob/master/documentation/trajectoryScan.html) +* [index.html](https://epics-modules.github.io/motor) (formerly motor.html) +* [motorDeviceDriver.html](https://epics-modules.github.io/motor/motorDeviceDriver.html) +* [motorRecord.html](https://epics-modules.github.io/motor/motorRecord.html) +* [motor_files.html](https://epics-modules.github.io/motor/motor_files.html) +* [motor_release.html](https://epics-modules.github.io/motor/motor_release.html) +* [trajectoryScan.html](https://epics-modules.github.io/motor/trajectoryScan.html) diff --git a/docs/index.html b/docs/index.html index d5806f8b..ee47f042 100644 --- a/docs/index.html +++ b/docs/index.html @@ -43,6 +43,15 @@ the links in the table below:
Known Problems Release Date + + Latest + R3.15.5-3.14.12.5 + master.zip + motorRecord.html + motor_release.html + Problems + n/a + R6-10 R3.15.5-3.14.12.5