Elvas Tower: Portable workbench for building the manual (old/obsolete) - Elvas Tower

Jump to content

Posting Rules

All new threads will be started by members of the Open Rails team, Staff, and/or Admins. Existing threads started in other forums may get moved here when it makes sense to do so.

Once a thread is started any member may post replies to it.
  • 3 Pages +
  • 1
  • 2
  • 3
  • You cannot start a new topic
  • You cannot reply to this topic

Portable workbench for building the manual (old/obsolete) Rate Topic: -----

#21 User is offline   Csantucci 

  • Member, Board of Directors
  • Group: Status: Elite Member
  • Posts: 7,000
  • Joined: 31-December 11
  • Gender:Male
  • Country:

Posted 20 March 2021 - 08:09 AM

Thanks Chris, I'll try!

P.S.: it works now; apparently, the only thing I missed was selecting Sphinx as explained at row 274 of your document.

#22 User is offline   cjakeman 

  • Vice President
  • PipPipPipPipPipPipPipPip
  • Group: ET Admin
  • Posts: 2,866
  • Joined: 03-May 11
  • Gender:Male
  • Location:Peterborough, UK
  • Simulator:Open Rails
  • Country:

Posted 20 March 2021 - 09:04 AM

View PostCsantucci, on 20 March 2021 - 08:09 AM, said:

P.S.: it works now; apparently, the only thing I missed was selecting Sphinx as explained at row 274 of your document.

Good to hear. I'm glad that you've got this working again.

#23 User is offline   James Ross 

  • Open Rails Developer
  • Group: Status: Elite Member
  • Posts: 5,490
  • Joined: 30-June 10
  • Gender:Not Telling
  • Simulator:Open Rails
  • Country:

Posted 21 March 2021 - 06:09 AM

View PostCsantucci, on 16 March 2021 - 01:06 AM, said:

I'm getting a problem trying to generate the manual. I enter "make html" in the command prompt window, Sphynx starts, but after some lines I get a Sphynx error telling me that contents.rst can't be found. In fact this file is not included in the Documentation pack. To proceed I have to manually generate a dummy file with such name. Am I doing something wrong?

This is the same error ReadTheDocs had, which occurs because earlier versions (RTD uses 1.7 or 1.8) of Sphinx assume contents.rst by default while newer versions (I have 3.x) assume index.rst.

You should be able to fix the problem by upgrading Sphinx or using the latest code, where I fixed the problem for RTD.

#24 User is offline   Csantucci 

  • Member, Board of Directors
  • Group: Status: Elite Member
  • Posts: 7,000
  • Joined: 31-December 11
  • Gender:Male
  • Country:

Posted 21 March 2021 - 08:43 AM

Thank you.

#25 User is offline   YoRyan 

  • Conductor
  • Group: Status: Active Member
  • Posts: 391
  • Joined: 19-February 20
  • Gender:Male
  • Location:California, United States
  • Simulator:Open Rails/unstable
  • Country:

Posted 08 January 2022 - 12:23 PM

As of 2022, I have switched to Visual Studio Code's development containers extension for editing and building the manual, and I would recommend that any current or potential contributors do so as well. With this extension, Docker Desktop will manage your copy of Sphinx, and will even pull the latest version as soon as it is released upstream. For more details, please see the GitHub PR, which Chris just merged in today.

I will no longer release new versions of the workbench, but it may still be useful for developers who do not have the resources to run Visual Studio Code and Docker Desktop.
  • 3 Pages +
  • 1
  • 2
  • 3
  • You cannot start a new topic
  • You cannot reply to this topic

1 User(s) are reading this topic
0 members, 1 guests, 0 anonymous users