Document Rekordbox library import

[Holzhaus]

trafficstars

Mixxx 2.3 will support importing removable device libraries from Rekordbox: https://mixxx.org/news/2020-07-20-new-in-2-3-rekordbox-support/

This should be briefly be documented here: https://mixxx.org/manual/2.3/en/chapters/library.html#itunes-traktor-rhythmbox-banshee-using-external-libraries

https://bugs.launchpad.net/mixxx/+bug/1898451

[UdokaVrede]

Hi I am Udoka an outreachy intern I want to work on this

[Holzhaus]

Hi I am Udoka an outreachy intern I want to work on this

Thanks!

[hannydevelop]

Hello @Holzhaus I think this issue has initially been open by @Be-ing here #136 what do you think

[Holzhaus]

Right, I didn't look it up properly, sorry. I'll close the other one.

[deborahtrez]

Hi @Holzhaus @ywwg , under this section https://mixxx.org/manual/2.3/en/chapters/library.html#using-libraries-from-other-software , there is a subtitle "Using the Serato library" that would go well under "Using external libraries". I could also add "Using the Rekordbox library" under the same section and describe how to import one from Rekordbox (from a removable device), if you approve. There is also some description of how to import a playlist from iTunes under the same section (but it doesn't have its own subheading as Serato does). Can I use this format https://mixxx.org/manual/2.3/en/chapters/getting_started.html#installing-mixxx for each of the descriptions instead? It think it would look more organised this way

[Be-ing]

Yes, I think the info for Rekordbox should be in a new subsection. Moving the info for iTunes to its own subsection would be helpful too.

[deborahtrez]

Yes, I think the info for Rekordbox should be in a new subsection. Moving the info for iTunes to its own subsection would be helpful too.

Great! Let me get started working on this.

[deborahtrez]

Hi @Be-ing @Holzhaus I'm running into a slight problem. I tried to pull the latest changes by doing git pull https://github.com/mixxxdj/manual.git because I needed to edit around this section https://mixxx.org/manual/2.3/en/chapters/library.html#using-the-serato-library.

But my local repo doesn't show that section. I also tried switching branches to manual-2.3.x (where that section was merged) and pulled from the upstream but no luck. How can i fetch the latest changes and see that section in my local repo?

[deborahtrez]

I tried this too but tests won't pass. I'm not sure about the errors that i would be resolving since i didn't edit these files...

[Holzhaus]

The rstcheck errors look like sphinx isn't installed, which is weird because it should take care of that automatically.

Please run git merge --abort, then run pre-commit --install-hooks.

Also, did you already make local changes? If not, I suggest to just start a fresh branch from manual-2.3.x like this:

git fetch upstream
git checkout -b rekordbox-library upstream/manual-2.3.x

[deborahtrez]

The rstcheck errors look like sphinx isn't installed, which is weird because it should take care of that automatically.

Please run git merge --abort, then run pre-commit --install-hooks.

Also, did you already make local changes? If not, I suggest to just start a fresh branch from manual-2.3.x like this:

git fetch upstream
git checkout -b rekordbox-library upstream/manual-2.3.x

I've done this, so I'm currently checked out at rekordbox-library branch. But i still don't have the section for "Using the Serato library" in my code. Maybe I can try to work without it, then everything will reflect in the upstream....?

[deborahtrez]

I have Sphinx installed

[Holzhaus]

Ah sorry, I forgot that we recently renamed branches. Instead of manual-2.3.x, the branch is now called 2.3. Please rebase on that branch, then it should work.

[deborahtrez]

Ah sorry, I forgot that we recently renamed branches. Instead of manual-2.3.x, the branch is now called 2.3. Please rebase on that branch, then it should work.

Okay. Let me do that. Thank you.

[deborahtrez]

Hi @Be-ing @Holzhaus do you think i should also include how to export the playlist from Rekordbox onto a removable device?

[Be-ing]

Yes. Does Pioneer have good documentation for that? If so, just link to that instead of rewriting that. If you could install Rekordbox and test it to make sure your instructions are complete and unambiguous that would be helpful.

[deborahtrez]

Yes. Does Pioneer have good documentation for that? If so, just link to that instead of rewriting that. If you could install Rekordbox and test it to make sure your instructions are complete and unambiguous that would be helpful.

Alright.

I ran into a slight issue while building with sphinx-build source build/html -b html -d build/doctrees -c source. Why do I get a Extension error: Could not import extension sphinx_mixxx (exception: No module named 'sphinx_mixxx').

I tried copying the code from the conf.py file in branch 2.3 and ran the command again. I got a Extension error: Could not import extension sphinxcontrib.rsvgconverter (exception: No module named 'sphinxcontrib.rsvgconverter') error.

[Holzhaus]

You need to install the build dependencies before you can build. I suggest to use a python virtual environment for this.

On Unix (Linux, macOS), you can do that with:

python -m venv myvenv
source myvenv/bin/activate

Now you're in a virtual python environment. All dependencies will be installed into the myvenv directories without polluting your main system. If you want to start from scratch, you can just remove the myvenv directory and create a new venv.

Install the dependencies with:

pip install -r requirements.txt

Now you can build the documentation.

To leave the venv, just type deactivate and hit enter.

Next time you want to activate the venv, just type source myvenv/bin/activate. All dependencies are still installed.

On Windows, you can activate the venv using myvenv\Scripts\activate.bat. See the Python docs for details: https://docs.python.org/3/library/venv.html

[deborahtrez]

You need to install the build dependencies before you can build. I suggest to use a python virtual environment for this.

On Unix (Linux, macOS), you can do that with:

python -m venv myvenv
source myvenv/bin/activate

Now you're in a virtual python environment. All dependencies will be installed into the myvenv directories without polluting your main system. If you want to start from scratch, you can just remove the myvenv directory and create a new venv.

Install the dependencies with:

pip install -r requirements.txt

Now you can build the documentation.

To leave the venv, just type deactivate and hit enter.

Next time you want to activate the venv, just type source myvenv/bin/activate. All dependencies are still installed.

On Windows, you can activate the venv using myvenv\Scripts\activate.bat. See the Python docs for details: https://docs.python.org/3/library/venv.html

Wow. Okay. Thank you @Holzhaus !

[deborahtrez]

Hi @Holzhaus I'm embarrassed to say that its been 9 hours and I still haven't solved this. I did all you suggested.

And made sure my fork was synced as well. and tried to build again inside the virtual env. But I still get the same error.

Im out of solutions at the moment. Can I commit and then use the Netlify build preview inside the pull request to view what I've done?

[Be-ing]

@deborahtrez please open a new topic in the development help stream on Zulip so the discussion here doesn't go too off topic.

[deborahtrez]

@deborahtrez please open a new topic in the development help stream on Zulip so the discussion here doesn't go too off topic.

Alright. Let me do that.