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

Build automated environment for contributors #8

Open
xames3 opened this issue Sep 4, 2024 · 1 comment
Open

Build automated environment for contributors #8

xames3 opened this issue Sep 4, 2024 · 1 comment
Assignees
Labels
blocked pull requests that are on hold due to dependencies, issues, or discussions that need to be resolved community contributions from the community or enhancements that support community engagement discussion needed pull requests that need community or team input before moving forward enhancement enhancements to existing functionality or the addition of new features help wanted extra attention is needed and appreciate some help high priority pull requests that should be reviewed and merged as a priority due to their importance open science contributions that enhance transparency, reproducibility, or accessibility in line with Open Science performance enhancements that optimize the speed or efficiency of the code question further information is requested by the team members or community

Comments

@xames3
Copy link
Collaborator

xames3 commented Sep 4, 2024

  • need to build an automated way of providing some basic features to interact with Sphinx for the community and contributors at large.
  • the initial plan for now is to write some basic Python scripts which can work over the CLI (preferably) that can allow the below features:
    • new rST file with pre-filled directives but in commented format as a template.
    • command-line wrapper to perform or mask sphinx-build command with all the feature flags enabled.

as of now, these two are something I feel are on priority and something the contributors might need to get started with.

@xames3 xames3 added blocked pull requests that are on hold due to dependencies, issues, or discussions that need to be resolved community contributions from the community or enhancements that support community engagement discussion needed pull requests that need community or team input before moving forward enhancement enhancements to existing functionality or the addition of new features help wanted extra attention is needed and appreciate some help high priority pull requests that should be reviewed and merged as a priority due to their importance open science contributions that enhance transparency, reproducibility, or accessibility in line with Open Science performance enhancements that optimize the speed or efficiency of the code question further information is requested by the team members or community labels Sep 4, 2024
@xames3 xames3 self-assigned this Sep 4, 2024
@xames3
Copy link
Collaborator Author

xames3 commented Sep 6, 2024

@gv2325 could you suggest any more things for this issue?

  • the plan is to automate the process of creating a new .rst with pre-filled comments which can be later discarded by the user. The file would act as a template on which the user will work upon and will provide all the features that I've written so far with some examples to refer to.
  • other thing as part of this automation process would be to build the pages.

NOTE: I'll be using Python for automation over bash as I'm assuming there would be people on Windows too without Git-Bash.

This is the theme I built for TOPST. Do let me know what you think and what can be made better.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked pull requests that are on hold due to dependencies, issues, or discussions that need to be resolved community contributions from the community or enhancements that support community engagement discussion needed pull requests that need community or team input before moving forward enhancement enhancements to existing functionality or the addition of new features help wanted extra attention is needed and appreciate some help high priority pull requests that should be reviewed and merged as a priority due to their importance open science contributions that enhance transparency, reproducibility, or accessibility in line with Open Science performance enhancements that optimize the speed or efficiency of the code question further information is requested by the team members or community
Projects
None yet
Development

No branches or pull requests

1 participant