Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Updated docs to follow our standard conf #65

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Jun 19, 2020
Merged

Updated docs to follow our standard conf #65

merged 10 commits into from
Jun 19, 2020

Conversation

philipstarkey
Copy link
Member

Also added links to other labscript suite docs and standard links.

@philipstarkey
Updated docs to follow our standard conf
35c5466 
Also added links to other labscript suite docs and standard links.
@philipstarkey
Copy link
Member Author

philipstarkey commented Jun 16, 2020 •
edited
Loading

The links to other labscript-suite project docs are dynamically generated so that stable docs have links to other stable docs, and latest links to latest. I don't know of any other way to do this easily (intersphinx does not work inside toctrees).

Note that this is currently not building on RTD: https://readthedocs.org/projects/philipstarkey-labscript/builds/11263059/
RTD is failing to install the labscript_utils dependency - not sure if that is expected or not given the current tagged release state...

@philipstarkey philipstarkey mentioned this pull request Jun 16, 2020
Merged
@rpanderson
Copy link
Member

rpanderson commented Jun 17, 2020 •
edited
Loading

RTD is failing to install the labscript_utils dependency - not sure if that is expected or not given the current tagged release state...

It might be because there are currently only pre-releases of labscript-utils and other components. I can reproduce the failure locally in a fresh venv and clone of labscript.

(.venv) > python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir .[docs]
ERROR: Could not find a version that satisfies the requirement labscript-utils>=2.14.0 (from labscript==3.0.0rc2.dev2+g28dc675) (from versions: 2.15.1.dev54, 3.0.0b2, 3.0.0rc1)
ERROR: No matching distribution found for labscript-utils>=2.14.0 (from labscript==3.0.0rc2.dev2+g28dc675)

Adding --pre resolves the issue, but this cannot be specified on RTD (see readthedocs/readthedocs.org#5018).

Curiously, this error does not arise when following either our regular or developer installation guide for pip, i.e. the pre-releases are installed without the --pre flag.

@rpanderson
Copy link
Member

rpanderson commented Jun 17, 2020 •
edited
Loading

One workaround (until we tag fully qualified releases) is to include a pre-release or development version in the offending install_requires entry in setup.cfg, e.g.

[options]
...
install_requires =
  ...
  labscript_utils>=2.14.0dev0

Working build with this modification here (commit | build log).

Alternatively, so that pre-releases are only allowed for documentation builds, we could include docs/requirements.txt containing the above requirement specification, and add the following to readthedocs.yaml:

python:
  install:
    - requirements: docs/requirements.txt
    ...

Update: The above method also works (commit | build log).

@philipstarkey
Copy link
Member Author

Cool! I've updated the requirement to >=3.0.0rc1. We needed to bump it to 3.0.0 anyway, so I don't think there is any downside to doing this (even if we forget to remove it - which hopefully we won't!)

Changes viewable here: https://philipstarkey-labscript.readthedocs.io/en/latest/components/

rpanderson
rpanderson reviewed Jun 19, 2020
View reviewed changes
@rpanderson rpanderson self-requested a review June 19, 2020 06:31
@philipstarkey philipstarkey merged commit 0362fa7 into labscript-suite:master Jun 19, 2020
philipstarkey added a commit that referenced this pull request Jun 25, 2020
@philipstarkey @chrisjbillington @rpanderson
Squashed commit of the following:
83856d6 
commit c3b7988
Author: Phil Starkey <[email protected]>
Date:   Thu Jun 25 18:27:06 2020 +1000

    Update labscript_utils dependency to `>=3.0.0`

commit 822e5d5
Merge: 2e2785c 39c6f0b
Author: Russell Anderson <[email protected]>
Date:   Thu Jun 25 15:48:15 2020 +1000

    Merge pull request #69 from rpanderson/example_fix

    Make example labscript functional and format using black

commit 39c6f0b
Author: Russell Anderson <[email protected]>
Date:   Thu Jun 25 12:34:08 2020 +1000

    Name all the args

commit 255d74e
Author: Russell Anderson <[email protected]>
Date:   Thu Jun 25 12:11:48 2020 +1000

    Name all arguments in connection table

commit e3d3ece
Author: Russell Anderson <[email protected]>
Date:   Thu Jun 25 11:08:25 2020 +1000

    Omit __init__ import and comply with flake8 F403

commit 6b26f1f
Author: Russell Anderson <[email protected]>
Date:   Sun May 31 17:38:18 2020 +1000

    Make example labscript functional and format using black

commit 2e2785c
Merge: 62b9098 4e77810
Author: Chris Billington <[email protected]>
Date:   Wed Jun 24 21:22:05 2020 -0400

    Merge pull request #70 from rpanderson/is-syntax-warning-bugfix

    Bugfix for ValueError introduced in #68

commit 4e77810
Author: Russell Anderson <[email protected]>
Date:   Thu Jun 25 11:18:56 2020 +1000

    Abbreviated bugfix.

commit a667f7e
Author: Russell Anderson <[email protected]>
Date:   Thu Jun 25 11:17:11 2020 +1000

    Bugfix for ValueError introduced in #68

commit 62b9098
Merge: 0e23ed0 1746399
Author: Chris Billington <[email protected]>
Date:   Wed Jun 24 20:49:32 2020 -0400

    Merge pull request #67 from philipstarkey/fix-h5py-file-mode

    Fix h5py deprecation warning

commit 0e23ed0
Merge: 5b52c20 6373f02
Author: Chris Billington <[email protected]>
Date:   Wed Jun 24 18:47:18 2020 -0400

    Merge pull request #68 from rpanderson/is-syntax-warning

    Do not use 'is' for numeric literal comparisons

commit 6373f02
Author: Russell Anderson <[email protected]>
Date:   Thu Jun 25 08:36:55 2020 +1000

    Omitted 'is' with numeric literal comparisons

commit 1746399
Author: philipstarkey <[email protected]>
Date:   Wed Jun 24 18:29:12 2020 +1000

    Fix h5py deprecation warning

    Addresses labscript-suite/labscript-utils#47 for the labscript module

commit 5b52c20
Merge: 0362fa7 88ce952
Author: Russell Anderson <[email protected]>
Date:   Mon Jun 22 18:09:54 2020 +1000

    Merge pull request #66 from philipstarkey/master

    Doc updates

commit 88ce952
Author: philipstarkey <[email protected]>
Date:   Sat Jun 20 18:17:23 2020 +1000

    Doc updates

    Renamed API reference URL to match labscript utils and updated config to fix bugs identified in labscript-suite/labscript-utils#57

commit 0362fa7
Merge: 74869ef 52d3b9f
Author: Phil Starkey <[email protected]>
Date:   Fri Jun 19 18:58:04 2020 +1000

    Merge pull request #65 from philipstarkey/master

    Updated docs to follow our standard conf

commit 52d3b9f
Author: philipstarkey <[email protected]>
Date:   Fri Jun 19 16:04:04 2020 +1000

    Addressing latest review comments

commit 7674a8f
Author: philipstarkey <[email protected]>
Date:   Fri Jun 19 11:19:33 2020 +1000

    Updated docs to use jinja template for component doc links

commit d4474e2
Author: philipstarkey <[email protected]>
Date:   Thu Jun 18 16:43:10 2020 +1000

    Updated .gitignore with latest GitHub defaults

commit a18a0d1
Author: philipstarkey <[email protected]>
Date:   Thu Jun 18 16:39:35 2020 +1000

    Relocated custom sphinx git ignore rules

commit 80aa5a1
Author: philipstarkey <[email protected]>
Date:   Thu Jun 18 16:21:44 2020 +1000

    Restored 64 pixel logo accidentally replaced with 32 pixel logo

commit 42d3bc6
Author: philipstarkey <[email protected]>
Date:   Thu Jun 18 16:17:42 2020 +1000

    Updated install requirement to 3.0.0rc1+

commit 1961a2c
Author: philipstarkey <[email protected]>
Date:   Thu Jun 18 16:13:40 2020 +1000

    testing dependency fix

commit 234753d
Author: philipstarkey <[email protected]>
Date:   Thu Jun 18 16:07:41 2020 +1000

    Updated as per the review in labscript-suite/labscript-suite#48

commit 74869ef
Author: Russell Anderson <[email protected]>
Date:   Wed Jun 17 10:24:43 2020 +1000

    Populated README.md with styling, iconogrpahy, prose, and badges

commit 28dc675
Author: philipstarkey <[email protected]>
Date:   Tue Jun 16 18:24:26 2020 +1000

    Removed unnecessary header and added intersphinx link

commit 35c5466
Author: philipstarkey <[email protected]>
Date:   Tue Jun 16 17:19:33 2020 +1000

    Updated docs to follow our standard conf

    Also added links to other labscript suite docs and standard links.

Co-authored-by: chrisjbillington <[email protected]>
Co-authored-by: Russell Anderson <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rpanderson rpanderson rpanderson approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@philipstarkey @rpanderson