Merge pull request #12 from dls-controls/docs-restructure

Docs restructure

Author: coretl

.github/workflows/code.yml

@@ -75,7 +75,7 @@ jobs:
           python-version: '3.7'
 
       - name: Install Python Dependencies
-        run: pip install twine build cibuildwheel
+        run: pip install build cibuildwheel
 
       - name: Build Sdist
         run: python -m build --sdist .
@@ -113,6 +113,9 @@ jobs:
           name: dist
           path: dist
 
+      - name: Install Python Dependencies
+        run: pip install twine
+
       - name: Publish to PyPI
         env:
           TWINE_USERNAME: __token__

.github/workflows/docs.yml

@@ -1,4 +1,3 @@
-
 name: Docs CI
 
 on:
@@ -14,7 +13,7 @@ jobs:
       - name: Checkout Source
         uses: actions/checkout@v2
         with:
-          # require history to get back to last tag for version number of brnaches
+          # require history to get back to last tag for version number of branches
           fetch-depth: 0
           submodules: true
 
@@ -31,11 +30,11 @@ jobs:
       - name: Build Docs
         run: pipenv run docs
 
-      - uses: jungwinter/split@v1
+      - uses: rishabhgupta/split-by@v1
         id: split
         with:
-          msg: ${{ github.ref }}
-          seperator: /
+          string: ${{ github.ref }}
+          split-by: /
 
       - name: Move to versioned directory
         # e.g. master or 0.1.2

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.rst

@@ -1,4 +1,4 @@
-PythonIOC
+pythonIoc
 =========
 
 |code_ci| |docs_ci| |coverage| |pypi_version| |license|

docs/_static/theme_overrides.css

@@ -18,13 +18,13 @@
 }
 
 /* Add two-column option */
-@media only screen and (min-width: 1000px),
-       only screen and (min-width: 500px) and (max-width: 768px){
+@media only screen and (min-width: 1000px) {
     .columns {
-        padding-left: 5px;
-        padding-right: 5px;
+        padding-left: 10px;
+        padding-right: 10px;
         float: left;
         width: 50%;
+        min-height: 145px;
     }
 }
 

docs/_templates/layout.html

@@ -12,30 +12,31 @@
   <a href="{{pathto('genindex.html', 1)}}">Index</a>
   <!-- Add versions for selected branches + tags -->
   <p class="caption"><span class="caption-text">Versions</span></p>
-  <ul id="versions"></ul>
+  <ul id="versions"/>
   <script>
-    // Versions to add, will be filtered by dirs
-    var versions = ['master'];
+    // Add any branches to appear in the side pane here, tags will be added below
+    // Will only appear if docs are built and pushed in gh-pages
+    var versions = ['master', 'main'];
     var dirs = new Set();
     function addVersion(name) {
       if (dirs.has(name)) {
         var li = document.createElement("li");
         var a = document.createElement("a");
-        a.href = 'https://dls-controls.github.io/pythonIoc/' + name;
+        a.href = 'https://dls-controls.github.io/{{ project }}/' + name;
         a.innerText = name;
         li.appendChild(a)
         document.getElementById('versions').appendChild(li);
       }
     }
     Promise.all([
-      // Find gh-pages directories
-      fetch("https://api.github.com/repos/dls-controls/pythonIoc/contents?ref=gh-pages")
+      // Find gh-pages directories and populate `dirs`
+      fetch("https://api.github.com/repos/dls-controls/{{ project }}/contents?ref=gh-pages")
       .then(response => response.json())
       .then(data => data.forEach(function(e) {
         if (e.type == "dir") dirs.add(e.name);
       })),
-      // Add tags that have pages
-      fetch('https://api.github.com/repos/dls-controls/pythonIoc/tags')
+      // Add tags to `versions`
+      fetch('https://api.github.com/repos/dls-controls/{{ project }}/tags')
         .then(response => response.json())
         .then(data => data.forEach(function(e) {
           versions.push(e.name);

docs/explanations/why-use-pythonIoc.rst

@@ -15,7 +15,7 @@ allows you to write this as:
 
     import numpy as np
     from cothread.catools import caget, camonitor
-    from softioc import builder
+    from softioc import builder, softioc
 
     # The PVs we want to average and their initial values
     PVs = [f"DEVICE{i}:CURRENT" for i in range(100)]
@@ -24,32 +24,67 @@ allows you to write this as:
     # The PV we want to serve
     avg = builder.aOut("AVERAGE:CURRENT", np.mean(values))
 
+    # Start the IOC
+    builder.LoadDatabase()
+    softioc.iocInit()
+
     # Make a monitor on the PVs to keep the value up to date
     def update_avg(value: float, index: int):
         values[index] = value
         avg.set(np.mean(values))
 
     camonitor(PVs, update_avg)
 
+    # Leave the IOC running with an interactive shell.
+    softioc.interactive_ioc(globals())
+
 ADD THE CONCENTRATOR USE CASE HERE
 
 Dynamically created PVs
 -----------------------
 
-Other use cases will do something like:
+Other use cases will require PVs to be created based on the features of a
+device. As EPICS database records are statically created at IOC boot, you
+can generate the database with a script, but pythonIoc allows you to write
+this as:
 
 .. code-block::
 
-    connect to device
-    make PVs
+    from my_device_lib import Device
+    import cothread
+    from softioc import builder, softioc
+
+    # Connect to the device
+    device = Device("hostname")
+    device.connect()
+
+    # Make a record for each parameter it has
+    records = {}
+    for param in device.get_params():
+        records[param] = builder.aIn(param.name, param.value)
+
+    # Start the IOC
+    builder.LoadDatabase()
+    softioc.iocInit()
+
+    # Poll the device for changes and update the records
+    def update_params():
+        while True:
+            for param in device.poll_changed_params():
+                records[param].set(param.value)
+
+    cothread.Spawn(update_params)
+
+    # Leave the IOC running with an interactive shell.
+    softioc.interactive_ioc(globals())
 
 ADD THE PANDA USE CASE HERE
 
 Existing Python Support
 -----------------------
 
 It may be that you have specific device support written in Python that you wish
-to expose as PVs.
-
-NEED A GOOD EXAMPLE HERE
+to expose as PVs. This could be either in the form of a device support library
+or using a Python library to calculate PV values as above.
 
+ADD THE FURKA/GRIMSEL MONITORING IOC USE CASE HERE