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

Documentation Build Fails After Changing File Extension From .rst to .md #1744

Open
otegami opened this issue Mar 26, 2024 · 0 comments
Open
Labels

Comments

@otegami
Copy link
Contributor

otegami commented Mar 26, 2024

What is your problem?

The document is no longer recognized as a target for translation when changing the file extension of a document in the project (for example, from .rst to .md). This issue can lead to build failures due to missing file errors during the documentation build process.

If you manually updated files.cmake like the following, the document is no longer recognized as a target for translation.

% git diff
diff --git a/doc/files.cmake b/doc/files.cmake
index 3aceb318f..1821b4576 100644
--- a/doc/files.cmake
+++ b/doc/files.cmake
@@ -22,7 +22,7 @@ set(GRN_DOC_SOURCES
     contribution/documentation.rst
     contribution/documentation/c-api.rst
     contribution/documentation/i18n.rst
-    contribution/documentation/introduction.rst
+    contribution/documentation/introduction.md
     contribution/report.rst
     development.rst
     development/travis-ci.rst

After this change, you can build it without errors.

% cmake --build ../groonga.doc --target doc_update_files
% git diff
diff --git a/doc/files.am b/doc/files.am
index 6b6190405..76140f16b 100644
--- a/doc/files.am
+++ b/doc/files.am
@@ -22,7 +22,7 @@ absolute_source_files = \
        $(top_srcdir)/doc/source/contribution/documentation.rst \
        $(top_srcdir)/doc/source/contribution/documentation/c-api.rst \
        $(top_srcdir)/doc/source/contribution/documentation/i18n.rst \
-       $(top_srcdir)/doc/source/contribution/documentation/introduction.rst \
+       $(top_srcdir)/doc/source/contribution/documentation/introduction.md \
        $(top_srcdir)/doc/source/contribution/report.rst \
        $(top_srcdir)/doc/source/development.rst \
        $(top_srcdir)/doc/source/development/travis-ci.rst \
@@ -1341,7 +1341,7 @@ source_files_relative_from_doc_dir = \
        source/contribution/documentation.rst \
        source/contribution/documentation/c-api.rst \
        source/contribution/documentation/i18n.rst \
-       source/contribution/documentation/introduction.rst \
+       source/contribution/documentation/introduction.md \
        source/contribution/report.rst \
        source/development.rst \
        source/development/travis-ci.rst \
diff --git a/doc/files.cmake b/doc/files.cmake
index 3aceb318f..1821b4576 100644
--- a/doc/files.cmake
+++ b/doc/files.cmake
@@ -22,7 +22,7 @@ set(GRN_DOC_SOURCES
     contribution/documentation.rst
     contribution/documentation/c-api.rst
     contribution/documentation/i18n.rst
-    contribution/documentation/introduction.rst
+    contribution/documentation/introduction.md
     contribution/report.rst
     development.rst
     development/travis-ci.rst

How to reproduce it

% git mv doc/source/contribution/documentation/introduction.rst doc/source/contribution/documentation/introduction.md
% cmake -S . -B ../groonga.doc --preset=doc
% cmake --build ../groonga.doc --target doc_update_files
ninja: error: '/home/otegami/dev/groonga/doc/source/contribution/documentation/introduction.rst', needed by 'doc/en-gettext.time_stamp', missing and no known rule to make it
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant