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

Line edit documentation #516

Merged
merged 1 commit into from
Feb 12, 2018
Merged

Line edit documentation #516

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions src/docs-developer-guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ ODK Docs uses:
- Sphinx_, a static-site generator written in Python_

Sphinx uses:

- Docutils_ for parsing reStructuredText_
- Jinja_ for templating

- sphinx_rtd_theme_, a Sphinx theme/template

sphinx_rtd_theme uses:

- JQuery_, a JavaScript library

- Proselint_ for style testing
- Proselint_ for style testing
- git_ and GitHub_ for version control
- CircleCI_ for testing and deployment
- CircleCI_ for testing and deployment
- `Amazon S3`_ for hosting


Expand All @@ -34,7 +34,7 @@ ODK Docs uses:
.. _docutils: http://docutils.sourceforge.net/
.. _restructuredtext: http://docutils.sourceforge.net/rst.html
.. _jinja: http://jinja.pocoo.org/
.. _sphinx_rtd_theme: https://github.com/rtfd/sphinx_rtd_theme
.. _sphinx_rtd_theme: https://github.com/rtfd/sphinx_rtd_theme
.. _proselint: http://proselint.com/
.. _git: https://git-scm.com/
.. _github: https://github.com/opendatakit/docs
Expand All @@ -47,12 +47,12 @@ ODK Docs uses:
Custom HTML templating
-------------------------

ODK Docs uses the sphinx_rtd_theme_,
ODK Docs uses the sphinx_rtd_theme_,
with some minor customizations.

ODK-specific versions of HTML/Jinja templates
are in :file:`_templates`.
Any file in that directory
Any file in that directory
will override the file of the same name
in the sphinx_rtd_theme source.

Expand All @@ -62,7 +62,7 @@ and then edit it.

Please commit the copied file unchanged before editing,
so that it is easy to track what you have changed.

.. _custom-js:

Custom JavaScript
Expand All @@ -82,15 +82,15 @@ so you can use it in your custom JS.
Custom CSS
------------

Custom CSS should be added in :file:`src/_static/css/custom.css`.
Custom CSS should be added in :file:`src/_static/css/custom.css`.
Comment your code with an explanation of what the CSS accomplishes
and a reference to the issue number you are working on.

For example:

.. code-block:: css

/* Example css PR #xyx */
/* Example CSS PR #xyx */

div[class^='example'] {
color: black;
Expand All @@ -100,13 +100,13 @@ It is helpful to keep the CSS file organized.
There are several sections in the :file:`custom.css` file:

- Styling for rst roles and directives
- Responsive css
- Responsive CSS
Copy link
Contributor

Choose a reason for hiding this comment

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

You can apply the fix here as well:

- Styling for JS implementation
- Utility classes

Each of these sections are enclosed in start and end comments.
Add your code to the relevant section.
If you don't find any section relevant,
Each of these sections are enclosed in start and end comments.
Add your code to the relevant section.
If you don't find any section relevant,
add a new section and add your code there.

For example:
Expand All @@ -115,10 +115,10 @@ For example:

/* New section starts */

/* Example css PR #xyx */
/* Example CSS PR #xyx */

div[class^='example'] {
color: black;
}
/* New section ends */

/* New section ends */