Merge pull request #326 from speco29/translation-docs

translable files

Author: aterrel

.github/workflows/build-gh-pages.yml

@@ -26,7 +26,7 @@ jobs:
     - name: Build the book
       run: |
         rm -rf DISCOVER/_tags/*
-        jupyter-book build DISCOVER
+        sphinx-build -b html DISCOVER/ DISCOVER/_build/html
 
     - name: Push book HTML to gh-pages
       uses: peaceiris/actions-gh-pages@v3.9.0

.gitignore

@@ -11,4 +11,8 @@ DISCOVER/_tags/
 venv/
 
 # in case of using pyenv
-.python-version
+.python-version
+
+# Ignore translation files
+*.pot
+*.mo

DISCOVER/_config.yml

@@ -0,0 +1,40 @@
+###############################################################################
+# Auto-generated by `jupyter-book config`
+# If you wish to continue using _config.yml, make edits to that file and
+# re-generate this one.
+###############################################################################
+author = 'Community'
+comments_config = {'hypothesis': False, 'utterances': False}
+copyright = '2023'
+
+exclude_patterns = ['**.ipynb_checkpoints', '.DS_Store', 'Thumbs.db', '_build']
+extensions = ['sphinx_togglebutton', 'sphinx_copybutton', 'myst_nb', 'jupyter_book', 'sphinx_external_toc', 'sphinx.ext.intersphinx', 'sphinx_design', 'sphinx_book_theme', 'sphinx_tags', 'sphinx_jupyterbook_latex', 'sphinx_multitoc_numbering']
+external_toc_exclude_missing = False
+external_toc_path = '_toc.yml'
+html_baseurl = ''
+html_css_files = ['css/mainLogo.css']
+html_favicon = ''
+html_js_files = ['js/footer.js', 'js/logo-switcher.js']
+html_logo = '_static/images/logo-light.png'
+html_sourcelink_suffix = ''
+html_static_path = ['_static']
+html_theme = 'sphinx_book_theme'
+html_theme_options = {'search_bar_text': 'Search this book...', 'launch_buttons': {'notebook_interface': 'classic', 'binderhub_url': '', 'jupyterhub_url': '', 'thebe': False, 'colab_url': '', 'deepnote_url': ''}, 'path_to_docs': 'DISCOVER', 'repository_url': 'https://github.com/numfocus/DISCOVER-Cookbook/', 'repository_branch': 'main', 'extra_footer': '', 'home_page_in_toc': True, 'announcement': '', 'analytics': {'google_analytics_id': '', 'plausible_analytics_domain': '', 'plausible_analytics_url': 'https://plausible.io/js/script.js'}, 'use_repository_button': True, 'use_edit_page_button': False, 'use_issues_button': True}
+html_title = 'DISCOVER'
+latex_engine = 'pdflatex'
+myst_enable_extensions = ['colon_fence', 'dollarmath', 'linkify', 'substitution', 'tasklist']
+myst_url_schemes = ['mailto', 'http', 'https']
+nb_execution_allow_errors = False
+nb_execution_cache_path = ''
+nb_execution_excludepatterns = []
+nb_execution_in_temp = False
+nb_execution_mode = 'force'
+nb_execution_timeout = 30
+nb_output_stderr = 'show'
+numfig = True
+pygments_style = 'sphinx'
+suppress_warnings = ['etoc.toctree']
+tags_create_tags = True
+tags_extension = ['md']
+use_jupyterbook_latex = True
+use_multitoc_numbering = True

DISCOVER/conf.py

@@ -51,8 +51,9 @@ To contribute changes:
 
 5. **Test Locally**: Build the book and view your changes:
    ```sh
-   jupyter-book build DISCOVER
+   sphinx-build -b html DISCOVER/ DISCOVER/_build/html
    python -m http.server 8000 --directory DISCOVER/_build/html/
+
    ```
    Visit [`http://localhost:8000`](http://localhost:8000) in your browser to verify changes.
 
@@ -86,7 +87,7 @@ conda activate DISCOVER-Cookbook
 ```
 3. Finally, to build the Jupyter Book
 ``` sh
-jupyter-book build DISCOVER
+sphinx-build -b html DISCOVER/ DISCOVER/_build/html
 ```
 
 ### If Using pip
@@ -109,7 +110,7 @@ pip install -r requirements.txt
 ```
 4. Finally, to build the Jupyter Book
 ``` sh
-jupyter-book build DISCOVER
+sphinx-build -b html DISCOVER/ DISCOVER/_build/html
 ```
 ### View Locally  
 After building, you can view the book in one of the following ways:  

README.md

@@ -0,0 +1,47 @@
+# Managing Translations
+
+To support localization efforts, follow these steps to extract translatable strings and update translations.
+
+## Generating `.pot` Files  
+
+To extract translatable text and generate `.pot` files, run:
+
+```sh
+sphinx-build -b gettext DISCOVER/ DISCOVER/_build/gettext
+```
+This will store extracted strings in .pot files inside DISCOVER/_build/gettext.
+
+## Updating .po Files
+To update existing translations, use the following command:
+
+```sh
+sphinx-intl update -p DISCOVER/_build/gettext -l <language-code>
+```
+Replace <language-code> with your target language (e.g., en, fr, de).
+
+## Applying Translations
+Once .po files are updated, compile them to .mo for use in the built documentation:
+
+```sh
+sphinx-build -D language=<language-code> -b html DISCOVER/ DISCOVER/_build/html
+
+```
+After compiling, rebuild the book to see the translations applied:
+
+#### **Option 1: Using a Local Server**  
+
+Run the following command to start a local server:  
+```sh
+python -m http.server 8000 --directory DISCOVER/_build/html/
+```
+Then, open [`http://localhost:8000`](http://localhost:8000) in your browser.  
+
+#### **Option 2: Opening the File Directly**  
+
+Alternatively, you can open the book directly by navigating to:  
+```
+DISCOVER/_build/html/index.html
+```
+and opening it in your browser.  
+
+> Note: Contributors working on multilingual support should ensure .po file updates are included in commits.

Translation.md

@@ -0,0 +1,207 @@
+# SOME DESCRIPTIVE TITLE.
+# Copyright (C) 2023
+# This file is distributed under the same license as the Project name not
+# set package.
+# FIRST AUTHOR <EMAIL@ADDRESS>, 2025.
+#
+#, fuzzy
+msgid ""
+msgstr ""
+"Project-Id-Version: Project name not set \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2025-06-12 16:54+0530\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
+"Language: es\n"
+"Language-Team: es <LL@li.org>\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Generated-By: Babel 2.17.0\n"
+
+#: ../DISCOVER/01_about.md:2
+msgid "About"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:4
+msgid "Summary"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:5
+msgid ""
+"This cookbook is intended as a resource for organizers of conferences and"
+" events with a particular focus on the tech sector in the United States. "
+"It focuses specifically on plans, decisions, and actions organizers can "
+"take to produce and manage a more diverse and inclusive event. The "
+"cookbook does not provide any specific advice about budgeting, "
+"scheduling, A/V capabilities, how to structure tracks, etc."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:7
+msgid "About this Cookbook:"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:9
+msgid ""
+"This cookbook is intended as a resource for **organizers of conferences "
+"and events** — with a particular focus on the tech sector in the United "
+"States — to **support and encourage diversity and inclusion** at those "
+"events."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:11
+msgid ""
+"It focuses specifically on plans, decisions, and actions organizers can "
+"take to produce and manage a more diverse and inclusive event."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:13
+msgid ""
+"_Funding to produce this cookbook was made possible by a generous grant "
+"from the_ **Moore Foundation** _._"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:15
+msgid "**Further Reading:**"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:16
+msgid ""
+"[DISCOVER Cookbook Checklist](/13_inclusive-checklist.md) — A practical "
+"checklist for conference organizers to implement inclusive measures "
+"effectively."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:18
+msgid "What this Cookbook is not:"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:20
+msgid ""
+"This cookbook is **not** intended to provide **general instructions** on "
+"how to run a successful conference or event. We do not provide any "
+"specific advice about budgeting, scheduling, A/V capabilities, how to "
+"structure tracks, etc."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:22
+msgid ""
+"Some &quot;basic&quot; best practice is understood to be a prerequisite "
+"for many of our recommendations. For example, live-captioning support for"
+" the hearing-impaired is not possible without reliable internet and good "
+"A/V setup. In general, we have avoided explicitly calling out these "
+"implied dependencies in order to maintain focus and keep the cookbook to "
+"a more manageable length."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:24
+msgid ""
+"This cookbook also does not offer reasons or rationale for **why "
+"inclusion and diversity are important**. The cookbook presumes the "
+"organizing committee is already interested in improving diversity and "
+"inclusion at their conference or event. Hence the suggestions herein are "
+"focused on the &quot;how&quot; rather than the &quot;why&quot;."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:27
+msgid "Acknowledgements:"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:29
+msgid ""
+"We sincerely appreciate the efforts and input of the many individuals who"
+" contributed to the creation of this cookbook. We also thank the numerous"
+" individuals and organizations whose work we have drawn from in order to "
+"compile this cookbook. Resources we consulted are collected at the end of"
+" each section under the heading &quot;Further Reading&quot;."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:31
+msgid "In particular, we thank:"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:33
+msgid ""
+"The NumFOCUS DISC Committee members who compiled the initial skeleton of "
+"this cookbook: Jennifer Klay, Reshama Shaikh, and Gina Helfrich. And "
+"those who set up this page: Mwai Karimi, Bojan Božić and Leonie Mueck"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:35
+msgid ""
+"Participants in the 2017 DISC Unconference who expanded and elaborated "
+"upon the initial skeleton: Kasia Rachuta, Ashley Otero, Dave Clements, "
+"Sarah Supp, Raniere Silva, and Tania Allard."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:38
+msgid "Other Considerations"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:40
+msgid "**Further reading:**"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:42
+msgid ""
+"[Scent and smoking policy](https://adacamp.org/adacamp-"
+"toolkit/policies/#scent)"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:43
+msgid ""
+"[Conference booklet "
+"template](http://geekfeminism.wikia.com/wiki/Conference_booklet_template)"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:46
+msgid "Special Considerations Depending on Geographic Context"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:48
+msgid ""
+"Most of the material contained herein is written from the U.S. "
+"perspective (e.g. Americans with Disabilities Act (ADA) protections)."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:49
+msgid ""
+"Something to be aware of: some U.S. states may have discriminatory laws "
+"in place which could affect whether you should choose to host an event or"
+" conference there."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:50
+msgid ""
+"We welcome input on considerations for events and conferences in other "
+"countries."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:51
+msgid ""
+"Additional considerations may need to be made for very remote event "
+"locations with no public transit, e.g. for folks who are mobility "
+"impaired."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:55
+msgid "REQUEST FOR INPUT"
+msgstr ""
+
+#: ../DISCOVER/01_about.md:57
+msgid ""
+"NumFOCUS invites the community to make suggestions for improvements to "
+"the DISCOVER Cookbook via pull request (PR). PRs will be evaluated by the"
+" NumFOCUS DISC Committee and/or its volunteers. PRs should be written so "
+"as to conform to the [NumFOCUS Contributor Code of "
+"Conduct](https://www.numfocus.org/about/code-of-conduct/)."
+msgstr ""
+
+#: ../DISCOVER/01_about.md:59
+msgid ""
+"For a full statement of the NumFOCUS DISC Program mission and the "
+"NumFOCUS position on diversity and inclusion, please see [Diversity and "
+"Inclusion](https://www.numfocus.org/programs/diversity-and-inclusion/)."
+msgstr ""
+