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.

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

docs: forward-ports from 3.x #256

Merged
merged 20 commits into from
Jul 24, 2024

Commits on Jul 11, 2024

  1. Pin specific version of Jinja2

    Before this change, the docs failed to build with the following
    error:
    
    ImportError: cannot import name 'environmentfilter' from 'jinja2'
    
    A fix to this problem is to explicitly pin Jinja2 version.
    
    (cherry picked from commit cdaf75a)
    avelanarius authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    8659c15 View commit details
    Browse the repository at this point in the history
  2. docs: update theme 1.2

    docs: update dynamic slug
    
    Add back index.md
    
    Move custom slug to a separate PR
    
    Fix typo
    
    (cherry picked from commit 8feeb20)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    f8c3c9d View commit details
    Browse the repository at this point in the history
  3. Add Java Driver 4.x branches to documentation

    Add Java Driver 4.x branches to the list of generated documentation
    and bump the LATEST_VERSION variable.
    
    (cherry picked from commit 76f7715)
    avelanarius authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    d92e6df View commit details
    Browse the repository at this point in the history
  4. docs: update theme 1.3

    (cherry picked from commit d2e261b)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    f4d4d79 View commit details
    Browse the repository at this point in the history
  5. fix: redirection to api reference

    Fix javadoc redirect
    
    Fix
    
    (cherry picked from commit a9fcffb)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    79eccb7 View commit details
    Browse the repository at this point in the history
  6. Add license notice

    (cherry picked from commit 7399a0a)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    680de75 View commit details
    Browse the repository at this point in the history
  7. Add java-driver.docs.scylladb.com replacements

    The links in our documentation have a hardcoded version number in them:
    
    https://java-driver.docs.scylladb.com/scylla-3.11.2.x/api/
    https://docs.datastax.com/en/drivers/java/3.11/com/datastax/driver/core/Cluster.html
    
    Therefore, a replacement rule is needed to replace the version to a
    correct version for a specific driver version we render the docs for.
    
    Before this change, only datastax links were replaced. After this
    change, java-driver.docs.scylladb.com links are also replaced.
    
    (cherry picked from commit 8cd4d8e)
    avelanarius authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    1e2ed28 View commit details
    Browse the repository at this point in the history
  8. Fix java-driver.docs.scylladb.com replacement

    (cherry picked from commit 511573f)
    avelanarius authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    d8345c1 View commit details
    Browse the repository at this point in the history
  9. Add 4.14.1.x and 4.15.0.x to generated docs

    Add 4.14.1.x and 4.15.0.x releases to the list of versions to generate
    the docs for.
    
    (cherry picked from commit d296895)
    avelanarius authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    b0a57a5 View commit details
    Browse the repository at this point in the history
  10. docs: update theme

    docs: update conf.py
    
    docs: update conf.py
    
    docs: Update conf.py
    
    docs: update conf.py
    
    docs: Update conf.py
    
    docs: update conf.py
    (cherry picked from commit 0d1f1c4)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    235c6ac View commit details
    Browse the repository at this point in the history
  11. docs: update conf.py

    docs: test
    
    docs: add skip warnings option
    (cherry picked from commit 2601b78)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    208efa6 View commit details
    Browse the repository at this point in the history
  12. docs: update theme 1.5

    (cherry picked from commit 51ff0d5)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    63ee0f9 View commit details
    Browse the repository at this point in the history
  13. docs: update theme 1.6

    (cherry picked from commit 7ab2a8f)
    dgarcia360 authored and tchaikov committed Jul 11, 2024
    Configuration menu
    Copy the full SHA
    dd8c03b View commit details
    Browse the repository at this point in the history

Commits on Jul 12, 2024

  1. docs: wrap long line for better readability

    Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
    (cherry picked from commit 6a5d3a7)
    tchaikov committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    963151e View commit details
    Browse the repository at this point in the history
  2. docs: update workflows

    (cherry picked from commit 8dea9e2)
    dgarcia360 authored and tchaikov committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    1010682 View commit details
    Browse the repository at this point in the history
  3. docs: add myst parser

    (cherry picked from commit 9eedcac)
    dgarcia360 authored and tchaikov committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    9b7c7f7 View commit details
    Browse the repository at this point in the history
  4. docs: triggered when on push to scylla-3.x

    this change is not cherry-picked from 4.x, as it is specific to
    scylla-3.x branch.
    
    Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
    tchaikov committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    eb97246 View commit details
    Browse the repository at this point in the history
  5. docs: update theme

    (cherry picked from commit efe5101)
    dgarcia360 authored and tchaikov committed Jul 12, 2024
    Configuration menu
    Copy the full SHA
    db334b9 View commit details
    Browse the repository at this point in the history

Commits on Jul 13, 2024

  1. docs: suppress warning from autosectionlabel

    to silence the warning from sphinx, as we have two "Dropwizard
    Metrics" sections in manual/core/metrics/index.md:
    
    ```
    /home/kefu/dev/scylla-java-driver/docs/_source/manual/core/metrics/index.md:291: WARNING: duplicate label manual/core/metrics/index:dropwizard metrics, other instance in /home/kefu/dev/scyll
    a-java-driver/docs/_source/manual/core/metrics/index.md
    ```
    
    and the warning breaks the "make test". so let's suppress the warning
    at this moment.
    
    Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
    tchaikov committed Jul 13, 2024
    Configuration menu
    Copy the full SHA
    04d1a58 View commit details
    Browse the repository at this point in the history
  2. manual: correct the codeblock directive

    it should start with three backticks not four of them. otherwise
    sphinx warns like:
    
    ```
    /home/kefu/dev/scylla-java-driver/docs/_source/manual/mapper/daos/getentity/index.md:111: WARNING: Lexing literal_block '@GetEntity\nProduct asProduct(Row row);\n\n@GetEntity\nProduct firstR
    owAsProduct(ResultSet resultSet);\n```\n\n' as "java" resulted in an error at token: '`'. Retrying in relaxed mode.
    ```
    
    in this change, let's use three backticks. and the warning disappears.
    
    Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>
    tchaikov committed Jul 13, 2024
    Configuration menu
    Copy the full SHA
    3311fc8 View commit details
    Browse the repository at this point in the history