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.

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

Add Sphinx documentation #12

Merged
merged 16 commits into from
Nov 8, 2021
Merged

Add Sphinx documentation #12

merged 16 commits into from
Nov 8, 2021

Commits on Nov 4, 2021

  1. Rename doc/ to docs/

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    3db90f8 View commit details
    Browse the repository at this point in the history

  2. Support cached properties in Sphinx

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    9064fa7 View commit details
    Browse the repository at this point in the history

  3. Remove API key residue

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    d6adab4 View commit details
    Browse the repository at this point in the history

  4. Add Sphinx documentation

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    24102a4 View commit details
    Browse the repository at this point in the history

  5. Add CI workflow for building Sphinx documentation

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    811f5ec View commit details
    Browse the repository at this point in the history

  6. Add Read the Docs configuration file

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    9efc32b View commit details
    Browse the repository at this point in the history

  7. Update colour of XCC title

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    7eea3dd View commit details
    Browse the repository at this point in the history

  8. Merge branch 'main' into sc-10957-sphinx

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    dbe31cb View commit details
    Browse the repository at this point in the history

  9. Apply formatter

    @Mandrenkov
    Mandrenkov committed Nov 4, 2021
    Configuration menu
    Copy the full SHA
    8890a9b View commit details
    Browse the repository at this point in the history

Commits on Nov 5, 2021

  1. Switch to using RST for the README

    @Mandrenkov
    Mandrenkov committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    44bcf20 View commit details
    Browse the repository at this point in the history

  2. Create walkthrough page from README sections

    @Mandrenkov
    Mandrenkov committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    bff6d85 View commit details
    Browse the repository at this point in the history

  3. Delete empty first line from circuit.xbb

    @Mandrenkov
    Mandrenkov committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    16189c3 View commit details
    Browse the repository at this point in the history

  4. Add docstrings to Settings attributes

    @Mandrenkov
    Mandrenkov committed Nov 5, 2021
    Configuration menu
    Copy the full SHA
    745387d View commit details
    Browse the repository at this point in the history

Commits on Nov 8, 2021

  1. Replace raw HTML with RST image directive

    @Mandrenkov
    Mandrenkov committed Nov 8, 2021
    Configuration menu
    Copy the full SHA
    1c61bea View commit details
    Browse the repository at this point in the history

  2. Replace :align: option with :width: option

    @Mandrenkov
    Mandrenkov authored Nov 8, 2021
    Configuration menu
    Copy the full SHA
    7fed8fd View commit details
    Browse the repository at this point in the history

  3. Update README.rst

    @Mandrenkov
    Mandrenkov authored Nov 8, 2021
    Configuration menu
    Copy the full SHA
    d5dab3f View commit details
    Browse the repository at this point in the history