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

QUALITY: Fix the terminal warnings upon running mkdocs serve command #410

Closed
1 task done
KAUR1984 opened this issue Jul 7, 2023 · 4 comments
Closed
1 task done
Assignees
Labels
💄code quality Improvements to the code quality or readability

Comments

@KAUR1984
Copy link
Contributor

KAUR1984 commented Jul 7, 2023

Description

Currently, upon running the mkdocs serve command, we are getting a few warnings in the output:

(venv) cecs-079225:access-hive.github.io u6871990$ mkdocs serve
INFO     -  Building documentation...
INFO     -  [macros] - Macros arguments: {'module_name': 'main', 'modules': [], 'include_dir': '', 'include_yaml': [], 'j2_block_start_string': '', 'j2_block_end_string': '',
            'j2_variable_start_string': '', 'j2_variable_end_string': '', 'on_undefined': 'keep', 'on_error_fail': False, 'verbose': False}
INFO     -  [macros] - Extra variables (config file): ['generator', 'social', 'analytics', 'supported', 'recommended', 'community']
INFO     -  [macros] - Extra filters (module): ['pretty']
INFO     -  Cleaning site directory
INFO     -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
              - call_contribute.md
              - community_resources/events/events/2022/ACCESSAmos2022.md
              - community_resources/events/events/2022/AMOS.md
              - community_resources/events/events/2022/CORDEXAmos2022.md
              - community_resources/events/events/2022/COSIMA_workshop.md
              - community_resources/events/events/2022/GC5Workshop.md
              - community_resources/events/events/2022/GroundTruthingClimateChange.md
              - community_resources/events/events/2022/SWOTAmos2022.md
              - community_resources/events/events/2022/bom_res_dev_workshop.md
              - community_resources/events/events/2022/e-research.md
              - community_resources/events/events/2023/ARDCResearchSkills.md
              - community_resources/events/events/2023/AuScopeAccessNRI_panel.md
              - community_resources/events/events/2023/COSIMA_Hackathon.md
              - community_resources/events/events/2023/JULES_annual_science_meeting.md
              - community_resources/events/events/2023/MachLearnOcean.md
              - community_resources/events/events/2023/SOOS.md
              - community_resources/events/events/2023/ScienceMeetParliamentPart1.md
              - community_resources/events/events/2023/ScienceMeetParliamentPart2.md
              - community_resources/events/events/2023/UMTutorial.md
              - community_resources/events/events/2023/UM_LFRicPartner_UNITE.md
              - community_resources/events/events/2023/UM_LFRic_User_Workshop.md
              - community_resources/events/events/2023/WCRP_Conference.md
              - community_resources/glossaries/glossary_access_nri.md
              - community_resources/glossaries/glossary_cssr.md
              - community_resources/glossaries/glossary_ipcc.md
              - models/configurations/access-s.md
              - models/running-a-model/running-access-s.md
              - models/running-a-model/getting_started/index.md
WARNING  -  Documentation file 'community_resources/index.md' contains a link to 'training/index.md' which is not found in the documentation files.
WARNING  -  [git-revision-date-localized-plugin] '/Users/u6871990/Downloads/ACCESS-NRI/access-hive-dev/access-hive.github.io/docs/community_resources/events/events/2023/JULES_annual_science_meeting.md' has no
            git logs, using current timestamp
WARNING  -  Documentation file 'model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_esmvaltool.md' contains a link to 'model_evaluation/model_evaluation_on_gadi/contribute/index.md' which is not
            found in the documentation files.
WARNING  -  Documentation file 'model_evaluation/model_evaluation_on_gadi/model_evaluation_on_gadi_pangeo_cosima.md' contains a link to 'model_evaluation/model_evaluation_on_gadi/contribute/index.md' which is
            not found in the documentation files.
INFO     -  Documentation built in 11.21 seconds
INFO     -  [12:31:53] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [12:31:53] Serving on http://127.0.0.1:8000/

Why

To fix any warnings in the production code of Access-Hive.

Close Criteria

  • Fix all 4 warnings.
@KAUR1984
Copy link
Contributor Author

KAUR1984 commented Jul 10, 2023

Fixed all warnings in the terminal output, except:

WARNING  -  [git-revision-date-localized-plugin] '/Users/u6871990/Downloads/ACCESS-NRI/access-hive-dev/access-hive.github.io/docs/community_resources/events/events/2023/JulesAnnualScienceMeeting.md' has
            no git logs, using current timestamp
WARNING  -  [git-revision-date-localized-plugin] '/Users/u6871990/Downloads/ACCESS-NRI/access-hive-dev/access-hive.github.io/docs/community_resources/events/events/2023/JulesAnnualScienceMeeting.md' has
            no git logs, using current timestamp
INFO     -  Documentation built in 7.37 seconds
INFO     -  [14:49:59] Reloading browsers
INFO     -  [14:49:59] Browser connected: http://127.0.0.1:8000/community_resources/events/

This warning appears whenever a new file is added to the docs/community_resources/events/events/2023 folder. Currently, it is showing this warning for JulesAnnualScienceMeeting.md file as it is the latest file added. Might need to ask Romain of how to fix this - https://github.com/rbeucher/mkdocs_events_plugin.git

@KAUR1984
Copy link
Contributor Author

@KAUR1984
Copy link
Contributor Author

@atteggiani @svenbuder was wondering if you have any ideas to fix this warning:

WARNING  -  [git-revision-date-localized-plugin] '/Users/u6871990/Downloads/ACCESS-NRI/access-hive-dev/access-hive.github.io/docs/community_resources/events/events/2023/JulesAnnualScienceMeeting.md' has
            no git logs, using current timestamp
WARNING  -  [git-revision-date-localized-plugin] '/Users/u6871990/Downloads/ACCESS-NRI/access-hive-dev/access-hive.github.io/docs/community_resources/events/events/2023/JulesAnnualScienceMeeting.md' has
            no git logs, using current timestamp
INFO     -  Documentation built in 7.37 seconds
INFO     -  [14:49:59] Reloading browsers
INFO     -  [14:49:59] Browser connected: http://127.0.0.1:8000/community_resources/events/

@atteggiani
Copy link
Contributor

atteggiani commented Jul 11, 2023

It's a problem related to the git-revision-date-localized-plugin, specificly in the get_date_formats_for_timestamp function.

It seems like the command git log -1 --date="unix" --format="%at" --no-show-signature ./docs/community_resources/events/events/2023/JulesAnnualScienceMeeting.md gives no output, however I do get an ouptut for it (1688964617).

I also tried using the same python function as the module, but I still get the same output, so I am not really sure why mkdocs cannot fetch that correctly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💄code quality Improvements to the code quality or readability
Projects
None yet
Development

No branches or pull requests

2 participants