Commit Graph

71 Commits (1fc6e4cb2a34940e631fc8b4ff82b73319c76bb4)

Author SHA1 Message Date
Manuel Kaufmann a1e33af392 Update code example about build process 2019-03-05 17:45:02 +01:00
Manuel Kaufmann 30c907ce24 Use :guilabel: for admin steps 2019-03-05 17:44:33 +01:00
Manuel Kaufmann 21c90335cc Be more specific about the limits 2019-03-05 17:44:33 +01:00
Manuel Kaufmann 7960b5142b Point users to use the configuration file instead of Admin options 2019-03-05 17:44:33 +01:00
Roman Gorshunov 7f0512fb00
Minor reordering of words in builds documentation 2019-02-06 22:52:39 +01:00
Roman Gorshunov d599d79f76
Changed image reference to :latest 2019-02-06 22:32:59 +01:00
Roman Gorshunov 55ed4dd11c
Change version references to :stable tag. 2019-02-06 22:06:08 +01:00
Santos Gallegos 8db81f1d93 Merge branch 'master' into config-file-v2-docs 2019-01-22 12:09:05 -05:00
Manuel Kaufmann 35856b0a9a
Merge pull request #4899 from rtfd/humitos/admin/crud-env-variables
CRUD for EnvironmentVariables from Project's admin
2019-01-15 18:34:52 +01:00
Manuel Kaufmann ca5cf05fc8 Add a document guide with more documentation 2019-01-14 12:45:46 +01:00
Santos Gallegos 264a693027 Merge branch 'master' into config-file-v2-docs 2019-01-02 13:35:31 -05:00
Jeff Hale cbc3270b5a
fixed missing apostrophe for possessive "project's" 2019-01-01 16:36:41 -05:00
Manuel Kaufmann dec39ba703 Tip communicating that environment variables can be added manually 2018-12-27 13:29:12 +01:00
Santos Gallegos c584485b3a Update link 2018-11-21 12:42:13 -05:00
Manuel Kaufmann b2be8532a2 Warning note to pin MkDocs requirements 2018-10-11 10:01:24 +02:00
David Fischer 9f11a11aef
Fix broken docs links 2018-09-28 16:02:09 -07:00
Santos Gallegos 2ba2a2547d Fix some typos in docs and code (#4646) 2018-09-19 13:11:43 -06:00
David Fischer 6b8ecd858d Add a note about specifying the version of build tools (#4562) 2018-08-24 14:41:55 -06:00
Eric Holscher 6c0349a1b3
Merge pull request #4508 from AumitLeon/patch-1
Update information on mkdocs build process
2018-08-21 21:40:54 +02:00
Santos Gallegos 2f7c2081ad Fix sentence 2018-08-15 23:08:55 -05:00
Aumit Leon bab54833c7
update to reflect rtd role in build process 2018-08-15 14:21:11 -04:00
Santos Gallegos ee9ab1a32b Sort packages
Vim powered :sort
2018-08-15 12:09:48 -05:00
Santos Gallegos 2bafef5860 Add tip about packages versions 2018-08-15 12:08:16 -05:00
Santos Gallegos 7720f6f2fc Add note about pre installed libs 2018-08-15 12:02:26 -05:00
Santos Gallegos 9475637bac Use double backtips 2018-08-15 11:59:14 -05:00
Santos Gallegos 3a0687d263 Update docs about build process
Describe each docker image used to build the docs
2018-08-13 17:59:31 -05:00
Aumit Leon 4d6bb9b625
add detailed information mkdocs build 2018-08-13 17:11:58 -04:00
Aumit Leon 8e31893720
add info on where markdown files should be 2018-08-13 14:45:11 -04:00
Aumit Leon a6ac3d5e32
add info on where build looks for markdown files 2018-08-12 21:57:42 -04:00
Aumit Leon be78d29372
Update information on mkdocs build process 2018-08-12 16:49:17 -04:00
David Fischer db7edc6d29
Add documentation for APIv2
- This is a pure docs PR, no code changes
- Move internal class API to "developer-interface" folder
- Move APIv1 into a folder and add APIv2
2018-06-19 14:56:24 -07:00
Santos Gallegos 8f3c966f09 Update docs 2018-06-06 22:13:10 -05:00
Eric Holscher f72591731d
Merge pull request #3498 from stsewd/update-docs
Update docs
2018-02-18 09:01:51 +07:00
Manuel Kaufmann 3c3445647c Log `git checkout` and expose to users (#3520)
* Log `git checkout` and expose to users

* Use `setup_env` and record for `git clone`

* Use LocalEnvironment to record VCS commands in the build

* Split LocalEnvironment into LocalBuildEnvironment and LocalEnvironment

* LocalEnvironment

* env fix

* Run VCS command in the proper environment

* Define env

* Proper env variables

* Pass proper env variables when running VCS commands

* warn_only in status

* Record command when inside a BuildEnvironment

* Remove --quiet options

* Do not record ``warn_only`` commands

* Refactor

* Add warn_only to other VCS

* Remove `update_imported_docs` and use UpdateDocsTask

* Hack the Environment logs to avoid fails because no version

* Abstraction for UpdateDocsTask and SyncRepositoryTask

These are two separated tasks that share some code by inheriting from
SyncRepositoryMixin.

The final goal (as ``core.views.hooks._build_url`` is *DEPRECATED*) is
to finally remove the SyncRepositoryTask and merge that code into
UpdateDocsTask.

* Allow to not record specific command

Either `record=False` or `warn_only=True` commands are not
recorded. This attributes can be set at initialization time or when
calling the `run()` method.

* Proper use of `record`, `warn_only` and the new `force_success`

* Use record_as_success instead of force_success

We need the real exit_code for some command since there are decisions
based on that code, but we want to record it as success.

So, the fake exit_code is saved in the database but the real exit_code
is used in the whole flow of the building process.

* Replace force_success to record_as_success in calls

* Lint

* Fix docs styling

* Remove unnecessary initializing variables
2018-02-16 15:41:17 -08:00
Santos Gallegos 57fd486f95 Rename Mkdocs to MkDocs 2018-02-15 20:25:42 -05:00
Santos Gallegos db2c67ac51 Style 2018-01-23 16:07:05 -05:00
Santos Gallegos 8c46050c71 Revert "Wrap to 80 characters"
This reverts commit 9cf1742370.
2018-01-23 15:54:36 -05:00
Santos Gallegos 9cf1742370 Wrap to 80 characters 2018-01-09 17:42:18 -05:00
Santos Gallegos d907524dde Remove note about changing README to index 2018-01-09 17:41:13 -05:00
Eric Holscher 74e5c538f5 Fixes #927. Add info to build page about docker. 2017-03-09 14:33:04 -08:00
Luke GB 21e1f341b3 Document the environment variables set during builds (#2577)
These might come in handy, and since people are relying on them already
it's well worth documenting them.
2017-01-06 15:04:18 -08:00
Eric Holscher 3d44170d47 Add bit about build limits. Fixes #1720 2016-01-29 17:45:17 -08:00
Eric Holscher a0edf4ddbb Fix doc on build conf.py lookup. Fixes #1754 2016-01-29 17:40:16 -08:00
Eric Holscher 68cfde3d3a Fix name of option 2016-01-12 15:31:10 -08:00
Jonathan MacCarthy 83ae04c34a Make explicit: no Mkdocs automatic PDF generation.
As MkDocs doesn't support  automatic PDF generation, selecting the
Mkdocs documentation type means that you can't enable PDF builds.  Where
Mkdocs or markdown is mentioned in the docs, this is more explicit.
2015-09-08 13:23:48 -06:00
Hutson Betts 2f0927e467 docs(builds): Include `doxygen` in package list. 2015-09-02 14:40:43 -04:00
Andrew Kreps c3a0288fd0 Adding the Wipe button to the version list UI, and associated functionality. #1297 2015-05-30 17:12:42 -07:00
Sean Allred 0425016d3c Fix LaTeX capitalization where appropriate 2015-03-31 09:43:42 -05:00
Marc Abramowitz ac7fb0cdca Sphinx => Mkdocs
Fix incorrect reference to Sphinx in Mkdocs section
2015-02-02 15:41:22 -08:00
Eric Holscher e3888d10c9 Document auto-discovery 2014-10-28 12:35:12 -07:00