GitLab

This commit makes the mahara them inherit from sphinx:classic instead of
basicstrap. The basicstrap dependencies are also removed.

- theme.conf updated to:
  - change parent to `classic`
  - mahara.css is commented out as it prevents the sidebar from being rendered
    in the new theme. Rather than being commented out mahara.css should be made
    compatible with the new theme.
- layout.html has been removed as that has dependencies on basicstrap. This
  may need to be changed if layout changes are required. Hopefully any changes
  can be limited to css and theme config.

Update sphinx

See merge request !8

This requires a change to layout.html to add a new attribute
LINK_SUFFIX (same as FILE_SUFFIX) as the new version of searchtools.js
requires both of these values to display search results correctly.

Some parts of the documentation cannot be tested by opening the html
files with a browser. For instance search will not work in that case.

The solution is to serve the built files with a nginx web server
running in a docker container. Add a script to do this along with
instructions.

Building a docker image from a stale base image can give unexpected
results. Add build.builder.sh script to make is easy to build the
image correctely.

WR340584, Fix broken search links

See merge request !7

The scheduled manual builds are currently producing a manual with broken
search links. The file extension is being set to `undefined` rather than
the expected `.html`.

It turns out that these builds are using `sphinx-build 3.1.2` and
searchtools.js now expects DOCUMENTATION_OPTIONS.LINK_SUFFIX rather than
DOCUMENTATION_OPTIONS.FILE_SUFFIX which is being produced by layout.

Solution: peg sphinx to the required version. Things can break when a later
version becomes available and it has not been tested by us.

Add a generatepot target to build the manual pot files for translations

See merge request !6

Now that we are at Mahara 20.04, the generating of the files
wouldn't have worked any more.

When you are searching for something and then
follow the link, it doesn't add the .html correctly
any more. This is to fix it.

Evonne Cheung authored Mar 03, 2020 and Kristina Hoeppner committed Mar 03, 2020

so section when navigated to directly are
displayed properly below the header

Evonne Cheung authored Mar 03, 2020 and Kristina Hoeppner committed Mar 03, 2020

The earlier fix resulted in section headers to
not be displayed any more.

Dockerize the manual build process

See merge request !5

Evonne Cheung authored Feb 23, 2020 and Kristina Hoeppner committed Feb 23, 2020

Adjusted the space from the header to the conent
to allow anchor links to be seen and not hidden
behind the header. More space is given to account
for different behaviour between Firefox and Chrome.

It should be easy for anyone to build the Mahara docs. Docker gives us that way.

Added a Dockerfile to create a docbuilder and updated the README.md

That now requires Python3 and that has been included in Docker

as it has fallen out of support

To get rid of mentioning "user" when "people"
are meant as best as possible.

See merge request !4

Use current Bootstrap colors for the various
admonitions to differentiate between note,
warning, and seealso admonitions more easily.

Can't display the logo image. Reverting to normal
text until this can be investigated.

Instead of only displaying a heading