#463 - Add github, gitlab, bitbucket page arguments option #464

jpsenior · 2017-09-16T00:24:27Z

This adds a few fast options that a user can specify in sphinx conf.py to augment the default URLs that we redirect to -- for example, bitbucket can append ?mode=edit rather than whatever defaults are available. Fixes #463

Blendify · 2017-09-16T01:16:53Z

I do not have a strong opinion on this so @ericholscher or @agjohnson should chime in here. But you also need to edit the theme.conf file

jpsenior · 2017-09-16T01:24:51Z

@Blendify Didn't see other options documented in theme.conf for the bitbucket/github/etc urls, so I was reluctant to add empty ones there. What do you recommend?

Blendify · 2017-09-16T01:27:54Z

I would still add the options to the theme.conf

ericholscher · 2017-09-18T08:24:00Z

These should be documented, and added as theme options, if we are going to officially support them. Seems like a reasonable change, though 👍

jessetan · 2017-11-22T11:50:31Z

I don't think this will work for GitLab (at least for linking to editing mode). The link is currently https://SERVER/USER/REPO/blob/BRANCH/FILENAME.ext, and the URL for editing replaces blob with edit: https://SERVER/USER/REPO/edit/BRANCH/FILENAME.ext

- use `pageview_mode` as option - Fix logic for some websites

Bitbucket has no way to control how we interact with there file viewer

Blendify · 2018-01-18T18:08:58Z

All review comments have been covered.

jessetan · 2018-01-19T10:15:33Z

README.rst

+.. code:: python
+
+    html_context = {
+        'pageview_mode': ''


This needs a prefix to clarify that it sets the way links to the version control system are formatted, rather than something related to RTD or the theme. github_pageview_mode is not suitable because the setting is used for GitHub, GitLab and BitBucket. What about vcs_pageview_mode?
I think this also needs documentation for bitbucket_user etc.

Blendify · 2018-01-19T16:30:44Z

Updated Var name but I'll handle the rest of the HTML context options in a separate PR.

jessetan · 2018-01-23T10:54:46Z

sphinx_rtd_theme/breadcrumbs.html

@@ -42,21 +42,21 @@
              <!-- User defined GitHub URL -->
              <a href="{{ meta['github_url'] }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
            {% else %}
-              <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
+              <a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/{{ vcs_pageview_mode|default("blob") }}/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>


I think theme.conf is a better place to put the default pageview mode so we have all defaults in one file, rather than spread over a conf file and the html template

See my other reply. I will wait to see if you agree before updating.

jessetan · 2018-01-23T11:03:22Z

README.rst

+
+.. code:: python
+
+    html_context = {


Is it technically possible to move this option (and the other VCS stuff later) to html_theme_options instead of html_context? It can be confusing to users that there are two places where project-wide configuration changes can be made (also see #529)

I think so the way I see it is html_context are things that we would want to know about the project while html_theme_options are things we want to configure how the theme looks and interacts. So I am ok moving this new option the html_theme_options but I think the rest should stay.

Blendify · 2018-01-30T20:06:02Z

All changes have been done. Time for review again.

jessetan · 2018-01-31T09:32:14Z

LGTM, only nit: "Changes how to view files when using display_github, display_gitlab, ect." -> "etc."

davidfischer

This worked well for me.

davidfischer · 2018-02-01T00:13:47Z

docs/configuring.rst

@@ -44,9 +48,12 @@ Base options
 * ``prev_next_buttons_location`` String. can take the value ``bottom``, ``top``, ``both`` , or ``None``
  and will display the "Next" and "Previous" buttons accordingly.
 * ``style_external_links`` Bool. Add an icon next to external links. Defaults to ``False``.
+* ``vcs_pageview_mode`` String. Changes how to view files when using `display_github`, `display_gitlab`, ect.


As @jessetan mentioned ect. -> etc.

davidfischer · 2018-02-01T00:14:41Z

docs/configuring.rst

+HTML Context Options
+--------------------
+
+TODO.


What's the plan for this separately from Base options?

I generally try to have TODO free code but if the plan is to quickly put something there I'm ok with this as a stopgap. I would just say remove it and add it completely in another PR. That's probably better than having a TODO.

Yes, I'll write a new PR right after this one is merged and before the release.

* rtfd/master: (252 commits) Docs: restructure (readthedocs#573) Docs: Fix typos (readthedocs#584) add missing quotes (bottom should be a string) (readthedocs#580) Typo: Contibuting => Contributing Allow versions popup to scroll (readthedocs#576) Add document block and rename bodycontent content Add a block around the page content Docs: httpdomain package name uses dash instead of period Update changlog for 0.2.5 (readthedocs#570) Run Grunt (readthedocs#568) Create CODE_OF_CONDUCT.md (readthedocs#562) readthedocs#463 - Add github, gitlab, bitbucket page arguments option (readthedocs#464) Remove from theme.conf Remove from docs Update footer.html (readthedocs#561) Refactor docs: split up & slim down read me Fix readthedocs#305 Move 1400px media-query to 1100px (readthedocs#396) Only output div.articleComments if the block has content (readthedocs#555) Readme cleanup (readthedocs#554) Add GitHub templates (readthedocs#410) ...

readthedocs#463 - Add github, gitlab, bitbucket page arguments option

d7e371d

Blendify added 6 commits December 17, 2017 21:25

Merge branch 'master' into fix-463

1012c8c

Merge branch 'master' into fix-463

065cab7

Update PR

e448b1e

- use `pageview_mode` as option - Fix logic for some websites

Dont touch my whitespace

0111c74

Add docs for pageview_mode

82c3dfb

Remove option from bitbucket

0dbdcae

Bitbucket has no way to control how we interact with there file viewer

Blendify requested review from ericholscher, agjohnson and jessetan January 18, 2018 18:08

Blendify added 2 commits January 18, 2018 13:33

Add back bitbuck viewmode support

fcbfcb4

Correct docs

aa6b103

Blendify requested a review from davidfischer January 18, 2018 18:35

jessetan requested changes Jan 19, 2018

View reviewed changes

Blendify added 2 commits January 19, 2018 11:28

Update docs for new var name

fcf9ece

Use vcs_pageview_mode var name

09d2839

jessetan requested changes Jan 23, 2018

View reviewed changes

Blendify mentioned this pull request Jan 25, 2018

0.3.0: Remaining todos #556

Closed

8 tasks

Blendify added 5 commits January 29, 2018 20:54

Merge branch 'master' into fix-463

c493c9d

Add docs back

d6358d2

Add todo for the future

a10bd66

Change to html theme option

13b8744

Update theme.conf

2aff369

jessetan approved these changes Jan 31, 2018

View reviewed changes

davidfischer approved these changes Feb 1, 2018

View reviewed changes

davidfischer added 2 commits January 31, 2018 16:17

Merge branch 'master' into fix-463

c034741

Fix typo

032cce0

Blendify merged commit 04520a0 into readthedocs:master Feb 1, 2018

agjohnson added this to the v0.3.0 milestone Mar 29, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#463 - Add github, gitlab, bitbucket page arguments option #464

#463 - Add github, gitlab, bitbucket page arguments option #464

jpsenior commented Sep 16, 2017 •

edited

Loading

Blendify commented Sep 16, 2017

jpsenior commented Sep 16, 2017

Blendify commented Sep 16, 2017

ericholscher commented Sep 18, 2017

jessetan commented Nov 22, 2017

Blendify commented Jan 18, 2018

jessetan Jan 19, 2018

Blendify commented Jan 19, 2018

jessetan Jan 23, 2018

Blendify Jan 23, 2018

jessetan Jan 23, 2018 •

edited

Loading

Blendify Jan 23, 2018

Blendify commented Jan 30, 2018

jessetan commented Jan 31, 2018

davidfischer left a comment

davidfischer Feb 1, 2018

davidfischer Feb 1, 2018

Blendify Feb 1, 2018

#463 - Add github, gitlab, bitbucket page arguments option #464

#463 - Add github, gitlab, bitbucket page arguments option #464

Conversation

jpsenior commented Sep 16, 2017 • edited Loading

Blendify commented Sep 16, 2017

jpsenior commented Sep 16, 2017

Blendify commented Sep 16, 2017

ericholscher commented Sep 18, 2017

jessetan commented Nov 22, 2017

Blendify commented Jan 18, 2018

jessetan Jan 19, 2018

Choose a reason for hiding this comment

Blendify commented Jan 19, 2018

jessetan Jan 23, 2018

Choose a reason for hiding this comment

Blendify Jan 23, 2018

Choose a reason for hiding this comment

jessetan Jan 23, 2018 • edited Loading

Choose a reason for hiding this comment

Blendify Jan 23, 2018

Choose a reason for hiding this comment

Blendify commented Jan 30, 2018

jessetan commented Jan 31, 2018

davidfischer left a comment

Choose a reason for hiding this comment

davidfischer Feb 1, 2018

Choose a reason for hiding this comment

davidfischer Feb 1, 2018

Choose a reason for hiding this comment

Blendify Feb 1, 2018

Choose a reason for hiding this comment

jpsenior commented Sep 16, 2017 •

edited

Loading

jessetan Jan 23, 2018 •

edited

Loading