Skip to content

Commit

Permalink
✏️ Tweak GitHub-flavored emoji vs. sphinxemoji
Browse files Browse the repository at this point in the history
  • Loading branch information
shnizzedy committed Jul 1, 2022
1 parent c74a884 commit 2e937b6
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 8 deletions.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ Documents #[issue number] by @[original issue author]
- [ ] My pull request has a descriptive title (not a vague title like `Update index.md`). <!-- If you want to in include a leading emoji, check out https://gitmoji.dev for a pseudo-standard set of options -->
- [ ] My pull request targets the `source` branch of the repository. <!-- Change this branch if you're targeting a branch other than `source` -->
- [ ] My commit messages follow best practices.
- [ ] My code follows the [established code style of the repository](../CONTRIBUTING.md).
- [ ] I tried [letting the CI build this branch on a fork or built the project locally](../CONTRIBUTING.md#building) and verified that there are no visible errors.
- [ ] My code follows the [established code style of the repository](../blob/source/CONTRIBUTING.rst).
- [ ] I tried [letting the CI build this branch on a fork or built the project locally](../blob/source/CONTRIBUTING.rst#building) and verified that there are no visible errors.

## Developer Certificate of Origin
<!-- You must read and understand the following attestation. -->
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ If you want to generate that bibliography entry without the citation:
Environment notes
*****************

* Because `C-PAC`_ and `cpac`_ have conflicting commandline commands, we first run any ``cpac`` commands in a virtual environment and spoof the ``command-output`` directive with ``code-block`` like
* \:construction_worker: Because `C-PAC`_ and `cpac`_ have conflicting commandline commands, we first run any ``cpac`` commands in a virtual environment and spoof the ``command-output`` directive with ``code-block`` like

.. code-block:: RST
Expand All @@ -244,9 +244,9 @@ Environment notes
:shell:
:ellipsis: 0,9
* |:heavy_plus_sign:| Check |circleci config|_ of the branch you're working from for build dependencies.
* \:heavy_plus_sign: Check |circleci config|_ of the branch you're working from for build dependencies.

* |:octocat:| Set an environment variable ``GITHUBTOKEN`` to a `personal access token <https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line>`_ to increase `your API rate limit <https://developer.github.com/v3/#rate-limiting>`_ from 60 to 5000 requests per hour (for getting `release notes from GitHub <https://github.com/FCP-INDI/C-PAC/releases>`_\ ).
* \:octocat: Set an environment variable ``GITHUBTOKEN`` to a `personal access token <https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line>`_ to increase `your API rate limit <https://developer.github.com/v3/#rate-limiting>`_ from 60 to 5000 requests per hour (for getting `release notes from GitHub <https://github.com/FCP-INDI/C-PAC/releases>`_\ ).

.. |circleci config| replace:: ``.circleci/config.yml``

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ GitHub Pages repo for FCP-INDI

## Editing

See [CONTRIBUTING](./CONTRIBUTING.md) for editing and contributing guidelines.
See [CONTRIBUTING](./CONTRIBUTING.rst) for editing and contributing guidelines.
8 changes: 6 additions & 2 deletions docs/_sources/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,11 @@ def yaml_to_rst(path):
'https://github.com/FCP-INDI/fcp-indi.github.io/raw/source/images'
).replace(
'fcp-indi.github.io/docs/',
f'fcp-indi.github.io/docs/{_url_version}/')
f'fcp-indi.github.io/docs/{_url_version}/'
).replace('* :octocat:', '* |:octocat:|')
for emoji in ['construction_worker', 'heavy_plus_sign', 'octocat']:
_converted = r'{}'.format(_converted).replace(
r'\:' + f'{emoji}:', f'|:{emoji}:|')

if _url_version == 'nightly':
_url_version = 'develop'
Expand Down Expand Up @@ -211,7 +215,7 @@ def _gh_rate_limit():
MMMMMMMMMMMMMMMMMMM | |
MMMMMMMMMMMMMMMMMMM | Set GITHUBTOKEN to your API token in |
MMMMMMMMMMMMMMMMMMMMM | your environment to increase rate limit. |
MMMMMMMMMMMMMMMMMMMMMMM | See CONTRIBUTING.md#environment-notes |
MMMMMMMMMMMMMMMMMMMMMMM | See CONTRIBUTING.rst#environment-notes |
MMMMMMMMMMMMMMMMMMMMMMMM |_ ______________________________________|
MMMM::- -:::::::- -::MMMM |/
MM~:~ 00~:::::~ 00~:~MM
Expand Down

0 comments on commit 2e937b6

Please sign in to comment.