You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We have Paragraph-level markup note in some generated files (gitignored). If you clone the project and compile it, source/locale/zh_CN/LC_MESSAGES/reference/generated will appear. In a file called optuna.create_study.po we have some lines like this:
msgid ""
"Database URL. If this argument is set to None, in-memory storage is used,"
" and the :class:`~optuna.study.Study` will not be persistent. .. note::"
" When a database URL is passed, Optuna internally uses `SQLAlchemy`_ "
"to handle the database. Please refer to `SQLAlchemy's document`_ for "
"further details. If you want to specify non-default options to "
"`SQLAlchemy Engine`_, you can instantiate "
":class:`~optuna.storages.RDBStorage` with your desired options and "
"pass it to the ``storage`` argument instead of a URL. .. _SQLAlchemy: "
"https://www.sqlalchemy.org/ .. _SQLAlchemy's document: "
"https://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls .."
" _SQLAlchemy Engine: "
"https://docs.sqlalchemy.org/en/latest/core/engines.html"
the .. note::" above represents notes directive. Here is the rendered output:
But it seems that this block cannot be changed with even slight modifications. For example, if we replace URL with U RL like this:
msgstr ""
"Database U RL. If this argument is set to None, in-memory storage is used,"
" and the :class:`~optuna.study.Study` will not be persistent. .. note::"
" When a database URL is passed, Optuna internally uses `SQLAlchemy`_ "
"to handle the database. Please refer to `SQLAlchemy's document`_ for "
"further details. If you want to specify non-default options to "
"`SQLAlchemy Engine`_, you can instantiate "
":class:`~optuna.storages.RDBStorage` with your desired options and "
"pass it to the ``storage`` argument instead of a URL. .. _SQLAlchemy: "
"https://www.sqlalchemy.org/ .. _SQLAlchemy's document: "
"https://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls .."
" _SQLAlchemy Engine: "
"https://docs.sqlalchemy.org/en/latest/core/engines.html"
the output will crash:
This was not a problem when the doc is not generated automatically. You can find .. note:: in some deprecated translations:
I guess probably this is due to the auto-generation mechanism and strict punctuation requirement of Sphinx note. Even changing URL to U L will lead to crashed output. Currently I haven't found a good solution for this problem.
The text was updated successfully, but these errors were encountered:
We have Paragraph-level markup
note
in some generated files (gitignored). If you clone the project and compile it,source/locale/zh_CN/LC_MESSAGES/reference/generated
will appear. In a file calledoptuna.create_study.po
we have some lines like this:the
.. note::"
above represents notes directive. Here is the rendered output:But it seems that this block cannot be changed with even slight modifications. For example, if we replace
URL
withU RL
like this:the output will crash:
This was not a problem when the doc is not generated automatically. You can find
.. note::
in some deprecated translations:doc-optuna-zh-cn/source/locale/zh_CN/LC_MESSAGES/reference/study.po
Line 503 in 85583f6
I guess probably this is due to the auto-generation mechanism and strict punctuation requirement of Sphinx note. Even changing
URL
toU L
will lead to crashed output. Currently I haven't found a good solution for this problem.The text was updated successfully, but these errors were encountered: