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.

Sign up for GitHub

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

Jump to bottom

reST, Sphinx, Read The Docs framework #684

Merged
merged 21 commits into from
Oct 2, 2018
Merged

reST, Sphinx, Read The Docs framework #684

merged 21 commits into from
Oct 2, 2018

Conversation

mbacchi
Copy link
Contributor

@mbacchi mbacchi commented Aug 3, 2018

Initial framework PR, will add more documentation shortly.

Submitter Checklist:

  • Submitted a ticket for my issue if one did not already exist.
  • Used Github auto-closing keywords in the commit message.
  • Added/updated tests for this change (for new code or code which already has tests).
  • Ran git rebase -i to squash commits (if needed).
  • Tagged reviewers and labelled the pull request as needed.
  • Request a security/privacy review as needed.

Test Plan:

Reviewer Checklist:

  • New files have MPL-2.0 license header.
  • Request a security/privacy review as needed.
  • Adequate test coverage exists to prevent regressions

@mbacchi
Initial addition of sphinx docs
c18ca35
@mbacchi
Add Sphinx documentation instructions
ded05c4 
Document how to use sphinx and readthedocs
for anyone who wants to contribute to
the documentation for the project.
@mbacchi
add custom css definition for RTD
6425c3c
@mbacchi
remove sphinx contents caption heading
bfe3696
@mbacchi
update urls for dev rpm/apt repos to proxies
5d6bf96
@mbacchi
Remove modindex
18a4803
@mbacchi
mention latex prereqs
50caa44
@mbacchi
Revert "mention latex prereqs"
6a1a322 
This reverts commit 50caa44.

I added this during my demo, removing as
its not a true prerequisite.
garrettr
garrettr suggested changes Aug 7, 2018
View reviewed changes
docs/source/installing-brave.rst Outdated

echo "deb [arch=amd64] https://brave-browser-apt-dev.s3.brave.com/ `lsb_release -sc` main" | sudo tee -a /etc/apt/sources.list.d/brave-`lsb_release -sc`.list

cat /etc/apt/sources.list.d/brave-xenial.list
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this step necessary? I assume this is part of your workflow for verifying the results of the previous commands, but without an annotation to that effect it seems superfluous. Remove it?

docs/source/installing-brave.rst Outdated


sha256sum brave-browser-dev_0.50.14_amd64.deb
319b925220d07cc4810fd9848a1d09a53d0d66e31e3ea0a8f892336fa26ac1c0  brave-browser-dev_0.50.14_amd64.deb
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These last two steps are equivalent to sha256sum -c brave-browser-dev_0.50.14_amd64.deb.sha256sum?

docs/source/installing-brave.rst Outdated

sudo apt install brave-browser-dev

To verify checksum::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this section included? It verifies a separately downloaded copy of the .deb, which is not equivalent to verifying the .deb that was installed via apt in the previous instruction. Also, apt does this for you.

docs/source/build-instructions.rst Show resolved Hide resolved
garrettr
garrettr reviewed Aug 7, 2018
View reviewed changes
Copy link
Contributor

@garrettr garrettr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer rebase to merge to keep your PR branch up to date with master.

mihaiplesa
mihaiplesa requested changes Sep 27, 2018
View reviewed changes
docs/source/installing-brave.rst Outdated

UBUNTU_CODENAME=$( (grep DISTRIB_CODENAME /etc/upstream-release/lsb-release || grep DISTRIB_CODENAME /etc/lsb-release) 2>/dev/null | cut -d'=' -f2 )

echo "deb [arch=amd64] https://brave-browser-apt-beta.s3.brave.com/ $UBUNTU_CODENAME main" | sudo tee -a /etc/apt/sources.list.d/brave-$UBUNTU_CODENAME.list
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

brave-$UBUNTU_CODENAME.list -> brave-browser-beta-$UBUNTU_CODENAME.list

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and same for dev below

mihaiplesa
mihaiplesa previously approved these changes Sep 28, 2018
View reviewed changes
@mbacchi
Keep developer documentation on GitHub wiki
cbe3b5c 
Avoid duplicating content in two locations as requested
in the comment:
#684 (comment)
@mbacchi
Copy link
Contributor Author

mbacchi commented Oct 1, 2018

@mihaiplesa when you get a moment please review my recent updates, I'd like to complete this PR so that we can have it in our master branch asap. Thanks!

mihaiplesa
mihaiplesa approved these changes Oct 2, 2018
View reviewed changes
Copy link
Contributor

@mihaiplesa mihaiplesa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good @mbacchi

garrettr
garrettr approved these changes Oct 2, 2018
View reviewed changes
Copy link
Contributor

@garrettr garrettr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks!

@mbacchi mbacchi merged commit 32cab0f into master Oct 2, 2018
@mbacchi mbacchi deleted the readthedocs branch October 3, 2018 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@garrettr garrettr garrettr approved these changes

@mihaiplesa mihaiplesa mihaiplesa approved these changes

@bbondy bbondy Awaiting requested review from bbondy

@w0ts0n w0ts0n Awaiting requested review from w0ts0n

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mbacchi @garrettr @mihaiplesa