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

docs: add devenv and linkcheck to Makefile and misc details #1565

Merged
merged 12 commits into from Nov 2, 2022
Merged

docs: add devenv and linkcheck to Makefile and misc details #1565

merged 12 commits into from Nov 2, 2022

Commits on Oct 22, 2022

  1. docs: add devenv and linkcheck to Makefile and misc details

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    2c2e9df View commit details
    Browse the repository at this point in the history

  2. Update .gitignore

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    0734b58 View commit details
    Browse the repository at this point in the history

  3. docs refactor: rename doc to docs, and adopt a docs/source folder

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    8a9a672 View commit details
    Browse the repository at this point in the history

  4. docs: update contributing link in readme

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    74a6727 View commit details
    Browse the repository at this point in the history

  5. docs: fix broken table formatting warning

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    75be194 View commit details
    Browse the repository at this point in the history

  6. docs: remove no longer relevant reference to scripts/ folder

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    42f2641 View commit details
    Browse the repository at this point in the history

  7. docs: cleanup path config, now only for autodoc detection of modules

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    58d75f3 View commit details
    Browse the repository at this point in the history

  8. docs: modernize docs/sorce/conf.py for readability

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    fb40f8b View commit details
    Browse the repository at this point in the history

  9. docs: use sphinx-rediraffe instead of custom script

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    29bfbab View commit details
    Browse the repository at this point in the history

  10. docs: add sphinx linkcheck build options

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    a85b106 View commit details
    Browse the repository at this point in the history

  11. docs: add sphinx opengraph extension

    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    0175610 View commit details
    Browse the repository at this point in the history

  12. docs: link out to built contributing docs and fix myst warnings 

    With documentation in plain markdown and as built myst-markdown we got
warnings about the links referencing section headers by name in myst.
Like this, we ensure that the built documentation works great instead of
compromising on that and getting warnings about it when building the
documentation.
    @consideRatio
    consideRatio committed Oct 22, 2022
    Configuration menu
    Copy the full SHA
    b3bdd15 View commit details
    Browse the repository at this point in the history