linuxmint / doc-developer-guide

The Linux Mint Developer Guide

Linux Mint Developer Guide

This document can be read at http://linuxmint-developer-guide.readthedocs.io.

The docs are written in reStructuredText.

Build:

To build locally, install python3-sphinx and python3-sphinx-rtd-theme

sudo apt-get install python3-sphinx python3-sphinx-rtd-theme

If you don't have``python`` installed, it will install for you.

And run make html in the docs directory.

The final result will be in the _build directory.

Alternatively, you can use pip3 to complete the process, but pay attention that this should be done only if you are in a virtual environment.

sudo apt install python3-pip

and using pip3 you will install the sphinx and sphinx_rtd_them

pip3 install sphinx sphinx_rtd_them

and then, run make html in the docs directory to get the same result.

Resources:

• https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
• http://www.sphinx-doc.org/en/stable/markup/inline.html
• http://www.writethedocs.org/guide/
• https://developers.google.com/style/highlights

License:

doc-developer-guide's Issues

olconofi

Blueberry needs an update

Since Blueberry has been replaced by Blueman, I think the related documentaion in the below page needs to be updated.

https://linuxmint-developer-guide.readthedocs.io/en/latest/xapps.html

Tutorial: Version Control section: after git clone: no repository detected

Tutorial instructions don't work in the Version control section:

apt update
apt install gitk
cd ~/Sandbox/
git clone https://github.com/linuxmint/mintsystem.git
gitk

Git clone runs and copies but no repository is detected later.

Actual command line output:

Git clone:

ryan@ryan-ADATA:~/Sandbox$ git clone https://github.com/linuxmint/mintsystem.gitCloning into 'mintsystem'...
remote: Enumerating objects: 23, done.
remote: Counting objects: 100% (23/23), done.
remote: Compressing objects: 100% (19/19), done.
remote: Total 1878 (delta 3), reused 10 (delta 2), pack-reused 1855
Receiving objects: 100% (1878/1878), 663.55 KiB | 4.37 MiB/s, done.
Resolving deltas: 100% (626/626), done.

Gitk:

ryan@ryan-ADATA:~/Sandbox$ gitk

(image is same as above)

Gitg:

gitg also reports an error, so the problem is with the git clone, somehow.

ryan@ryan-ADATA:~/Sandbox$ gitg

(gitg:20674): GLib-GIO-CRITICAL **: 13:22:40.821: g_converter_convert: assertion 'outbuf_size > 0' failed

** (gitg:20674): WARNING **: 13:22:40.821: gitg-resource.vala:33: Error while loading resource: style-unix.css:1:0Failed to import: The resource at “/org/gnome/gitg/ui/style-unix.css” failed to decompress

Consolidate all developer docs into one place?

I was wondering if it might be a good idea to consolidate all information for developers into one place. Specifically, move the contents of projects.linuxmint.com here and also some of the contents at github.com/linuxmint/cinnamon/wiki that's not specific to that repository. This should make it so there's one place where new developer can be directed to when they have questions, make it easier for contributors to find what they're looking for and make it easier to keep this content up to date. Any thoughts?

Mint tools needs an update

It's been a long time since the document has been edited. Some tools have been retired, and others have emerged. The document should reflect the changes.

sphinx dependency not met, cannot be installed via method provided

From https://github.com/AMDphreak/doc-developer-guide

ryan@ryan-ADATA:~/code/online/doc-developer-guide/docs$ make html
Running Sphinx v1.6.7
loading pickled environment... not yet created

Theme error:
sphinx_rtd_theme is no longer a hard dependency since version 1.4.0. Please install it manually.(pip install sphinx_rtd_theme)
Makefile:20: recipe for target 'html' failed
make: *** [html] Error 1

It does not tell me which version of python this make is using, so I installed sphinx_rtd_theme on both python 2.7.x and 3.x via pip and pip3. This resolved nothing.

No work-around available (afaik)

Is the Ubuntu packaging guide relevant to Linux Mint?

Just that.