Skip to content

https://mysqlclient.readthedocs.io/ documentation is outdated #552

Closed

Description

@matusvalo

Read this first

We don't use this issue tracker to help users. If you had trouble, please ask it on some user community. See here.
Please use this tracker only when you are sure about it is an issue of this software.

And please provide full information from first. I don't want to ask questions like "What is your Python version?", "Do you confirm MySQL error log?". If the issue report looks incomplete, I will just close it.

Are you ready? Please remove until here and make a good issue report!!

Describe the bug

Documentation in https://mysqlclient.readthedocs.io/ is outdated comparing to the code in repository. The last build is 2 years old:
image

So some new functionality (e.g. ssl_mode parameter) is present only in source code and easily missed by users.

Activity

  1. changed the title [-]https://mysqlclient.readthedocs.io/ documenation is outdated[/-] [+]https://mysqlclient.readthedocs.io/ documentation is outdated[/+] on Aug 12, 2022
  2. okainov commented on Jan 16, 2023

    @okainov

    It seems very out-of-date, even the connect example is wrong, the actual code will complain for db or passwd parameters...

  3. methane commented on Jan 17, 2023

    @methane
    Member

    I had changed the default branch name from master to main.
    I think it broke the RTD.

  4. methane commented on Jan 17, 2023

    @methane
    Member

    libmysqlclient is needed to build the doc.
    So I can not fix the RTD manual.

  5. methane commented on Jan 17, 2023

    @methane
    Member

    I succeeded to build the doc by adding config file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions